Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>
com.google.cloud.discoveryengine.v1beta.SearchRequest.Builder
All Implemented Interfaces:
SearchRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest
public static final class SearchRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder> implements SearchRequestOrBuilder
 Request message for
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • clear

      public SearchRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • getDefaultInstanceForType

      public SearchRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SearchRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>

    • mergeFrom

      public SearchRequest.Builder mergeFrom(SearchRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.Builder>

    • mergeFrom

      public SearchRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>
      Throws:
      IOException

    • getServingConfig

      public String getServingConfig()
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getServingConfig in interface SearchRequestOrBuilder
      Returns:
      The servingConfig.

    • getServingConfigBytes

      public 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) = { ... }
      Specified by:
      getServingConfigBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for servingConfig.

    • setServingConfig

      public SearchRequest.Builder setServingConfig(String value)
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The servingConfig to set.
      Returns:
      This builder for chaining.

    • clearServingConfig

      public SearchRequest.Builder clearServingConfig()
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setServingConfigBytes

      public SearchRequest.Builder setServingConfigBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for servingConfig to set.
      Returns:
      This builder for chaining.

    • getBranch

      public String getBranch()
       The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.
      string branch = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getBranch in interface SearchRequestOrBuilder
      Returns:
      The branch.

    • getBranchBytes

      public 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) = { ... }
      Specified by:
      getBranchBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for branch.

    • setBranch

      public SearchRequest.Builder setBranch(String value)
       The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.
      string branch = 2 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The branch to set.
      Returns:
      This builder for chaining.

    • clearBranch

      public SearchRequest.Builder clearBranch()
       The branch resource name, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

 Use `default_branch` as the branch ID or leave this field empty, to search
 documents under the default branch.
      string branch = 2 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setBranchBytes

      public 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`.

 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) = { ... }
      Parameters:
      value - The bytes for branch to set.
      Returns:
      This builder for chaining.

    • getQuery

      public String getQuery()
       Raw search query.
      string query = 3;
      Specified by:
      getQuery in interface SearchRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Raw search query.
      string query = 3;
      Specified by:
      getQueryBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public SearchRequest.Builder setQuery(String value)
       Raw search query.
      string query = 3;
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchRequest.Builder clearQuery()
       Raw search query.
      string query = 3;
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       Raw search query.
      string query = 3;
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • hasImageQuery

      public boolean hasImageQuery()
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
      Specified by:
      hasImageQuery in interface SearchRequestOrBuilder
      Returns:
      Whether the imageQuery field is set.

    • getImageQuery

      public SearchRequest.ImageQuery getImageQuery()
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
      Specified by:
      getImageQuery in interface SearchRequestOrBuilder
      Returns:
      The imageQuery.

    • setImageQuery

      public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery value)
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;

    • setImageQuery

      public SearchRequest.Builder setImageQuery(SearchRequest.ImageQuery.Builder builderForValue)
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;

    • mergeImageQuery

      public SearchRequest.Builder mergeImageQuery(SearchRequest.ImageQuery value)
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;

    • clearImageQuery

      public SearchRequest.Builder clearImageQuery()
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;

    • getImageQueryBuilder

      public SearchRequest.ImageQuery.Builder getImageQueryBuilder()
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;

    • getImageQueryOrBuilder

      public SearchRequest.ImageQueryOrBuilder getImageQueryOrBuilder()
       Raw image query.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery image_query = 19;
      Specified by:
      getImageQueryOrBuilder in interface SearchRequestOrBuilder

    • getPageSize

      public int getPageSize()
       Maximum number of [Document][google.cloud.discoveryengine.v1beta.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;
      Specified by:
      getPageSize in interface SearchRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public SearchRequest.Builder setPageSize(int value)
       Maximum number of [Document][google.cloud.discoveryengine.v1beta.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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchRequest.Builder clearPageSize()
       Maximum number of [Document][google.cloud.discoveryengine.v1beta.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:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.
      string page_token = 5;
      Specified by:
      getPageToken in interface SearchRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.
      string page_token = 5;
      Specified by:
      getPageTokenBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public SearchRequest.Builder setPageToken(String value)
       A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.
      string page_token = 5;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchRequest.Builder clearPageToken()
       A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.
      string page_token = 5;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT`  error is returned.
      string page_token = 5;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getOffset

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

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      int32 offset = 6;
      Specified by:
      getOffset in interface SearchRequestOrBuilder
      Returns:
      The offset.

    • setOffset

      public 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.v1beta.Document]s deemed by the API
 as relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1beta.SearchRequest.page_token]
 is unset.

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      int32 offset = 6;
      Parameters:
      value - The offset to set.
      Returns:
      This builder for chaining.

    • clearOffset

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

 If this field is negative, an  `INVALID_ARGUMENT`  is returned.
      int32 offset = 6;
      Returns:
      This builder for chaining.

    • getOneBoxPageSize

      public 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;
      Specified by:
      getOneBoxPageSize in interface SearchRequestOrBuilder
      Returns:
      The oneBoxPageSize.

    • setOneBoxPageSize

      public SearchRequest.Builder setOneBoxPageSize(int value)
       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;
      Parameters:
      value - The oneBoxPageSize to set.
      Returns:
      This builder for chaining.

    • clearOneBoxPageSize

      public SearchRequest.Builder clearOneBoxPageSize()
       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:
      This builder for chaining.

    • getDataStoreSpecsList

      public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
      Specified by:
      getDataStoreSpecsList in interface SearchRequestOrBuilder

    • getDataStoreSpecsCount

      public int getDataStoreSpecsCount()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
      Specified by:
      getDataStoreSpecsCount in interface SearchRequestOrBuilder

    • getDataStoreSpecs

      public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
      Specified by:
      getDataStoreSpecs in interface SearchRequestOrBuilder

    • setDataStoreSpecs

      public SearchRequest.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • setDataStoreSpecs

      public SearchRequest.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addDataStoreSpecs

      public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addDataStoreSpecs

      public SearchRequest.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addDataStoreSpecs

      public SearchRequest.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addDataStoreSpecs

      public SearchRequest.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addAllDataStoreSpecs

      public SearchRequest.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • clearDataStoreSpecs

      public SearchRequest.Builder clearDataStoreSpecs()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • removeDataStoreSpecs

      public SearchRequest.Builder removeDataStoreSpecs(int index)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • getDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • getDataStoreSpecsOrBuilder

      public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
      Specified by:
      getDataStoreSpecsOrBuilder in interface SearchRequestOrBuilder

    • getDataStoreSpecsOrBuilderList

      public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;
      Specified by:
      getDataStoreSpecsOrBuilderList in interface SearchRequestOrBuilder

    • addDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • addDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • getDataStoreSpecsBuilderList

      public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()
       Specs defining dataStores to filter on in a search call and configurations
 for those dataStores. This is only considered for engines with multiple
 dataStores use case. For single dataStore within an engine, they should
 use the specs at the top level.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec data_store_specs = 32;

    • getFilter

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

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

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

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 7;
      Specified by:
      getFilter in interface SearchRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public SearchRequest.Builder setFilter(String value)
       The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the documents being filtered. Filter
 expression is case-sensitive.

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

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

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 7;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

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

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

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

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 7;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public 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. 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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getCanonicalFilter

      public String getCanonicalFilter()
       The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
      string canonical_filter = 29;
      Specified by:
      getCanonicalFilter in interface SearchRequestOrBuilder
      Returns:
      The canonicalFilter.

    • getCanonicalFilterBytes

      public 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.v1beta.SearchRequest.filter].
      string canonical_filter = 29;
      Specified by:
      getCanonicalFilterBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for canonicalFilter.

    • setCanonicalFilter

      public SearchRequest.Builder setCanonicalFilter(String value)
       The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
      string canonical_filter = 29;
      Parameters:
      value - The canonicalFilter to set.
      Returns:
      This builder for chaining.

    • clearCanonicalFilter

      public SearchRequest.Builder clearCanonicalFilter()
       The default filter that is applied when a user performs a search without
 checking any filters on the search page.

 The filter applied to every search request when quality improvement such as
 query expansion is needed. In the case a query does not have a sufficient
 amount of results this filter will be used to determine whether or not to
 enable the query expansion flow. The original filter will still be used for
 the query expanded search.
 This field is strongly recommended to achieve high search quality.

 For more information about filter syntax, see
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
      string canonical_filter = 29;
      Returns:
      This builder for chaining.

    • setCanonicalFilterBytes

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

 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.v1beta.SearchRequest.filter].
      string canonical_filter = 29;
      Parameters:
      value - The bytes for canonicalFilter to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public String getOrderBy()
       The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1beta.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;
      Specified by:
      getOrderBy in interface SearchRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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.v1beta.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;
      Specified by:
      getOrderByBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public SearchRequest.Builder setOrderBy(String value)
       The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1beta.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;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public SearchRequest.Builder clearOrderBy()
       The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1beta.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:
      This builder for chaining.

    • setOrderByBytes

      public SearchRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1beta.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;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • hasUserInfo

      public boolean hasUserInfo()
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
      Specified by:
      hasUserInfo in interface SearchRequestOrBuilder
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      public UserInfo getUserInfo()
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
      Specified by:
      getUserInfo in interface SearchRequestOrBuilder
      Returns:
      The userInfo.

    • setUserInfo

      public SearchRequest.Builder setUserInfo(UserInfo value)
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;

    • setUserInfo

      public SearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;

    • mergeUserInfo

      public SearchRequest.Builder mergeUserInfo(UserInfo value)
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;

    • clearUserInfo

      public SearchRequest.Builder clearUserInfo()
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;

    • getUserInfoBuilder

      public UserInfo.Builder getUserInfoBuilder()
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;

    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
      Specified by:
      getUserInfoOrBuilder in interface SearchRequestOrBuilder

    • getLanguageCode

      public 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;
      Specified by:
      getLanguageCode in interface SearchRequestOrBuilder
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      public 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;
      Specified by:
      getLanguageCodeBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for languageCode.

    • setLanguageCode

      public SearchRequest.Builder setLanguageCode(String value)
       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;
      Parameters:
      value - The languageCode to set.
      Returns:
      This builder for chaining.

    • clearLanguageCode

      public SearchRequest.Builder clearLanguageCode()
       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:
      This builder for chaining.

    • setLanguageCodeBytes

      public SearchRequest.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for languageCode to set.
      Returns:
      This builder for chaining.

    • getRegionCode

      public String getRegionCode()
       The Unicode country/region code (CLDR) of a location, such as "US" and
 "419". For more information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). If set,
 then results will be boosted based on the region_code provided.
      string region_code = 36;
      Specified by:
      getRegionCode in interface SearchRequestOrBuilder
      Returns:
      The regionCode.

    • getRegionCodeBytes

      public com.google.protobuf.ByteString getRegionCodeBytes()
       The Unicode country/region code (CLDR) of a location, such as "US" and
 "419". For more information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). If set,
 then results will be boosted based on the region_code provided.
      string region_code = 36;
      Specified by:
      getRegionCodeBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for regionCode.

    • setRegionCode

      public SearchRequest.Builder setRegionCode(String value)
       The Unicode country/region code (CLDR) of a location, such as "US" and
 "419". For more information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). If set,
 then results will be boosted based on the region_code provided.
      string region_code = 36;
      Parameters:
      value - The regionCode to set.
      Returns:
      This builder for chaining.

    • clearRegionCode

      public SearchRequest.Builder clearRegionCode()
       The Unicode country/region code (CLDR) of a location, such as "US" and
 "419". For more information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). If set,
 then results will be boosted based on the region_code provided.
      string region_code = 36;
      Returns:
      This builder for chaining.

    • setRegionCodeBytes

      public SearchRequest.Builder setRegionCodeBytes(com.google.protobuf.ByteString value)
       The Unicode country/region code (CLDR) of a location, such as "US" and
 "419". For more information, see [Standard
 fields](https://cloud.google.com/apis/design/standard_fields). If set,
 then results will be boosted based on the region_code provided.
      string region_code = 36;
      Parameters:
      value - The bytes for regionCode to set.
      Returns:
      This builder for chaining.

    • getFacetSpecsList

      public List<SearchRequest.FacetSpec> getFacetSpecsList()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
      Specified by:
      getFacetSpecsList in interface SearchRequestOrBuilder

    • getFacetSpecsCount

      public int getFacetSpecsCount()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
      Specified by:
      getFacetSpecsCount in interface SearchRequestOrBuilder

    • getFacetSpecs

      public SearchRequest.FacetSpec getFacetSpecs(int index)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
      Specified by:
      getFacetSpecs in interface SearchRequestOrBuilder

    • setFacetSpecs

      public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec value)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • setFacetSpecs

      public SearchRequest.Builder setFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec value)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec value)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(SearchRequest.FacetSpec.Builder builderForValue)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addFacetSpecs

      public SearchRequest.Builder addFacetSpecs(int index, SearchRequest.FacetSpec.Builder builderForValue)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addAllFacetSpecs

      public SearchRequest.Builder addAllFacetSpecs(Iterable<? extends SearchRequest.FacetSpec> values)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • clearFacetSpecs

      public SearchRequest.Builder clearFacetSpecs()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • removeFacetSpecs

      public SearchRequest.Builder removeFacetSpecs(int index)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder(int index)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsOrBuilder

      public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
      Specified by:
      getFacetSpecsOrBuilder in interface SearchRequestOrBuilder

    • getFacetSpecsOrBuilderList

      public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
      Specified by:
      getFacetSpecsOrBuilderList in interface SearchRequestOrBuilder

    • addFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • addFacetSpecsBuilder

      public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder(int index)
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • getFacetSpecsBuilderList

      public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()
       Facet specifications for faceted search. If empty, no facets are returned.

 A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
 error is returned.
      repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;

    • hasBoostSpec

      public 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.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      hasBoostSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public 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.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      getBoostSpec in interface SearchRequestOrBuilder
      Returns:
      The boostSpec.

    • setBoostSpec

      public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)
       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.v1beta.SearchRequest.BoostSpec boost_spec = 10;

    • setBoostSpec

      public SearchRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)
       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.v1beta.SearchRequest.BoostSpec boost_spec = 10;

    • mergeBoostSpec

      public SearchRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)
       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.v1beta.SearchRequest.BoostSpec boost_spec = 10;

    • clearBoostSpec

      public SearchRequest.Builder clearBoostSpec()
       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.v1beta.SearchRequest.BoostSpec boost_spec = 10;

    • getBoostSpecBuilder

      public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()
       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.v1beta.SearchRequest.BoostSpec boost_spec = 10;

    • getBoostSpecOrBuilder

      public 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.v1beta.SearchRequest.BoostSpec boost_spec = 10;
      Specified by:
      getBoostSpecOrBuilder in interface SearchRequestOrBuilder

    • getParamsCount

      public int getParamsCount()
      Description copied from interface: SearchRequestOrBuilder
       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;
      Specified by:
      getParamsCount in interface SearchRequestOrBuilder

    • containsParams

      public boolean containsParams(String key)
       Additional search parameters.

 For public website search only, supported values are:

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

 For available codes see [Country
 Codes](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;
      Specified by:
      containsParams in interface SearchRequestOrBuilder

    • getParams

      @Deprecated public Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.
      Specified by:
      getParams in interface SearchRequestOrBuilder

    • getParamsMap

      public 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;
      Specified by:
      getParamsMap in interface SearchRequestOrBuilder

    • getParamsOrDefault

      public 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;
      Specified by:
      getParamsOrDefault in interface SearchRequestOrBuilder

    • getParamsOrThrow

      public 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;
      Specified by:
      getParamsOrThrow in interface SearchRequestOrBuilder

    • clearParams

      public SearchRequest.Builder clearParams()

    • removeParams

      public SearchRequest.Builder removeParams(String key)
       Additional search parameters.

 For public website search only, supported values are:

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

 For available codes see [Country
 Codes](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;

    • getMutableParams

      @Deprecated public Map<String,com.google.protobuf.Value> getMutableParams()
      Deprecated.
      Use alternate mutation accessors instead.

    • putParams

      public SearchRequest.Builder putParams(String key, com.google.protobuf.Value value)
       Additional search parameters.

 For public website search only, supported values are:

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

 For available codes see [Country
 Codes](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;

    • putAllParams

      public SearchRequest.Builder putAllParams(Map<String,com.google.protobuf.Value> values)
       Additional search parameters.

 For public website search only, supported values are:

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

 For available codes see [Country
 Codes](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;

    • putParamsBuilderIfAbsent

      public com.google.protobuf.Value.Builder putParamsBuilderIfAbsent(String key)
       Additional search parameters.

 For public website search only, supported values are:

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

 For available codes see [Country
 Codes](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

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

    • getQueryExpansionSpec

      public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      Specified by:
      getQueryExpansionSpec in interface SearchRequestOrBuilder
      Returns:
      The queryExpansionSpec.

    • setQueryExpansionSpec

      public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • setQueryExpansionSpec

      public SearchRequest.Builder setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.Builder builderForValue)
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • mergeQueryExpansionSpec

      public SearchRequest.Builder mergeQueryExpansionSpec(SearchRequest.QueryExpansionSpec value)
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • clearQueryExpansionSpec

      public SearchRequest.Builder clearQueryExpansionSpec()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • getQueryExpansionSpecBuilder

      public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;

    • getQueryExpansionSpecOrBuilder

      public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
       The query expansion specification that specifies the conditions under which
 query expansion occurs.
      .google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      Specified by:
      getQueryExpansionSpecOrBuilder in interface SearchRequestOrBuilder

    • hasSpellCorrectionSpec

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

    • getSpellCorrectionSpec

      public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      Specified by:
      getSpellCorrectionSpec in interface SearchRequestOrBuilder
      Returns:
      The spellCorrectionSpec.

    • setSpellCorrectionSpec

      public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • setSpellCorrectionSpec

      public SearchRequest.Builder setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.Builder builderForValue)
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • mergeSpellCorrectionSpec

      public SearchRequest.Builder mergeSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec value)
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • clearSpellCorrectionSpec

      public SearchRequest.Builder clearSpellCorrectionSpec()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • getSpellCorrectionSpecBuilder

      public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;

    • getSpellCorrectionSpecOrBuilder

      public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
       The spell correction specification that specifies the mode under
 which spell correction takes effect.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      Specified by:
      getSpellCorrectionSpecOrBuilder in interface SearchRequestOrBuilder

    • getUserPseudoId

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

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

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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;
      Specified by:
      getUserPseudoId in interface SearchRequestOrBuilder
      Returns:
      The userPseudoId.

    • getUserPseudoIdBytes

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

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

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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;
      Specified by:
      getUserPseudoIdBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for userPseudoId.

    • setUserPseudoId

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

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

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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;
      Parameters:
      value - The userPseudoId to set.
      Returns:
      This builder for chaining.

    • clearUserPseudoId

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

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

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id]

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
      string user_pseudo_id = 15;
      Returns:
      This builder for chaining.

    • setUserPseudoIdBytes

      public SearchRequest.Builder setUserPseudoIdBytes(com.google.protobuf.ByteString value)
       A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

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

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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;
      Parameters:
      value - The bytes for userPseudoId to set.
      Returns:
      This builder for chaining.

    • hasContentSearchSpec

      public boolean hasContentSearchSpec()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
      Specified by:
      hasContentSearchSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the contentSearchSpec field is set.

    • getContentSearchSpec

      public SearchRequest.ContentSearchSpec getContentSearchSpec()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
      Specified by:
      getContentSearchSpec in interface SearchRequestOrBuilder
      Returns:
      The contentSearchSpec.

    • setContentSearchSpec

      public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec value)
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • setContentSearchSpec

      public SearchRequest.Builder setContentSearchSpec(SearchRequest.ContentSearchSpec.Builder builderForValue)
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • mergeContentSearchSpec

      public SearchRequest.Builder mergeContentSearchSpec(SearchRequest.ContentSearchSpec value)
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • clearContentSearchSpec

      public SearchRequest.Builder clearContentSearchSpec()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • getContentSearchSpecBuilder

      public SearchRequest.ContentSearchSpec.Builder getContentSearchSpecBuilder()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;

    • getContentSearchSpecOrBuilder

      public SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()
       A specification for configuring the behavior of content search.
      .google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
      Specified by:
      getContentSearchSpecOrBuilder in interface SearchRequestOrBuilder

    • hasEmbeddingSpec

      public boolean hasEmbeddingSpec()
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
      Specified by:
      hasEmbeddingSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the embeddingSpec field is set.

    • getEmbeddingSpec

      public SearchRequest.EmbeddingSpec getEmbeddingSpec()
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
      Specified by:
      getEmbeddingSpec in interface SearchRequestOrBuilder
      Returns:
      The embeddingSpec.

    • setEmbeddingSpec

      public SearchRequest.Builder setEmbeddingSpec(SearchRequest.EmbeddingSpec value)
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;

    • setEmbeddingSpec

      public SearchRequest.Builder setEmbeddingSpec(SearchRequest.EmbeddingSpec.Builder builderForValue)
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;

    • mergeEmbeddingSpec

      public SearchRequest.Builder mergeEmbeddingSpec(SearchRequest.EmbeddingSpec value)
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;

    • clearEmbeddingSpec

      public SearchRequest.Builder clearEmbeddingSpec()
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;

    • getEmbeddingSpecBuilder

      public SearchRequest.EmbeddingSpec.Builder getEmbeddingSpecBuilder()
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;

    • getEmbeddingSpecOrBuilder

      public SearchRequest.EmbeddingSpecOrBuilder getEmbeddingSpecOrBuilder()
       Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.EmbeddingSpec.EmbeddingVector.vector][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector]
 and the document embedding that is provided in
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path].

 If
 [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
 is not provided, it will use
 [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config].
      .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
      Specified by:
      getEmbeddingSpecOrBuilder in interface SearchRequestOrBuilder

    • getRankingExpression

      public String getRankingExpression()
       The ranking expression controls the customized ranking on retrieval
 documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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;
      Specified by:
      getRankingExpression in interface SearchRequestOrBuilder
      Returns:
      The rankingExpression.

    • getRankingExpressionBytes

      public com.google.protobuf.ByteString getRankingExpressionBytes()
       The ranking expression controls the customized ranking on retrieval
 documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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;
      Specified by:
      getRankingExpressionBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for rankingExpression.

    • setRankingExpression

      public SearchRequest.Builder setRankingExpression(String value)
       The ranking expression controls the customized ranking on retrieval
 documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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;
      Parameters:
      value - The rankingExpression to set.
      Returns:
      This builder for chaining.

    • clearRankingExpression

      public SearchRequest.Builder clearRankingExpression()
       The ranking expression controls the customized ranking on retrieval
 documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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;
      Returns:
      This builder for chaining.

    • setRankingExpressionBytes

      public SearchRequest.Builder setRankingExpressionBytes(com.google.protobuf.ByteString value)
       The ranking expression controls the customized ranking on retrieval
 documents. This overrides
 [ServingConfig.ranking_expression][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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;
      Parameters:
      value - The bytes for rankingExpression to set.
      Returns:
      This builder for chaining.

    • getRankingExpressionBackendValue

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

    • setRankingExpressionBackendValue

      public SearchRequest.Builder setRankingExpressionBackendValue(int value)
       The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for rankingExpressionBackend to set.
      Returns:
      This builder for chaining.

    • getRankingExpressionBackend

      public SearchRequest.RankingExpressionBackend getRankingExpressionBackend()
       The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRankingExpressionBackend in interface SearchRequestOrBuilder
      Returns:
      The rankingExpressionBackend.

    • setRankingExpressionBackend

      public SearchRequest.Builder setRankingExpressionBackend(SearchRequest.RankingExpressionBackend value)
       The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The rankingExpressionBackend to set.
      Returns:
      This builder for chaining.

    • clearRankingExpressionBackend

      public SearchRequest.Builder clearRankingExpressionBackend()
       The backend to use for the ranking expression evaluation.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend ranking_expression_backend = 53 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getSafeSearch

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

    • setSafeSearch

      public SearchRequest.Builder setSafeSearch(boolean value)
       Whether to turn on safe search. This is only supported for
 website search.
      bool safe_search = 20;
      Parameters:
      value - The safeSearch to set.
      Returns:
      This builder for chaining.

    • clearSafeSearch

      public SearchRequest.Builder clearSafeSearch()
       Whether to turn on safe search. This is only supported for
 website search.
      bool safe_search = 20;
      Returns:
      This builder for chaining.

    • getUserLabelsCount

      public int getUserLabelsCount()
      Description copied from interface: SearchRequestOrBuilder
       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;
      Specified by:
      getUserLabelsCount in interface SearchRequestOrBuilder

    • containsUserLabels

      public boolean containsUserLabels(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;
      Specified by:
      containsUserLabels in interface SearchRequestOrBuilder

    • getUserLabels

      @Deprecated public Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.
      Specified by:
      getUserLabels in interface SearchRequestOrBuilder

    • getUserLabelsMap

      public Map<String,String> getUserLabelsMap()
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;
      Specified by:
      getUserLabelsMap in interface SearchRequestOrBuilder

    • getUserLabelsOrDefault

      public String getUserLabelsOrDefault(String key, String defaultValue)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;
      Specified by:
      getUserLabelsOrDefault in interface SearchRequestOrBuilder

    • getUserLabelsOrThrow

      public String getUserLabelsOrThrow(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;
      Specified by:
      getUserLabelsOrThrow in interface SearchRequestOrBuilder

    • clearUserLabels

      public SearchRequest.Builder clearUserLabels()

    • removeUserLabels

      public SearchRequest.Builder removeUserLabels(String key)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • getMutableUserLabels

      @Deprecated public Map<String,String> getMutableUserLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putUserLabels

      public SearchRequest.Builder putUserLabels(String key, String value)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • putAllUserLabels

      public SearchRequest.Builder putAllUserLabels(Map<String,String> values)
       The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
 characters and cannot be empty. Values can be empty and have a maximum
 length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
 underscores, and dashes. All characters must use UTF-8 encoding, and
 international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
 key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 22;

    • hasNaturalLanguageQueryUnderstandingSpec

      public boolean hasNaturalLanguageQueryUnderstandingSpec()
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
      Specified by:
      hasNaturalLanguageQueryUnderstandingSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the naturalLanguageQueryUnderstandingSpec field is set.

    • getNaturalLanguageQueryUnderstandingSpec

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
      Specified by:
      getNaturalLanguageQueryUnderstandingSpec in interface SearchRequestOrBuilder
      Returns:
      The naturalLanguageQueryUnderstandingSpec.

    • setNaturalLanguageQueryUnderstandingSpec

      public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;

    • setNaturalLanguageQueryUnderstandingSpec

      public SearchRequest.Builder setNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder builderForValue)
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;

    • mergeNaturalLanguageQueryUnderstandingSpec

      public SearchRequest.Builder mergeNaturalLanguageQueryUnderstandingSpec(SearchRequest.NaturalLanguageQueryUnderstandingSpec value)
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;

    • clearNaturalLanguageQueryUnderstandingSpec

      public SearchRequest.Builder clearNaturalLanguageQueryUnderstandingSpec()
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;

    • getNaturalLanguageQueryUnderstandingSpecBuilder

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder getNaturalLanguageQueryUnderstandingSpecBuilder()
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;

    • getNaturalLanguageQueryUnderstandingSpecOrBuilder

      public SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder getNaturalLanguageQueryUnderstandingSpecOrBuilder()
       If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
 natural language query understanding will be done.
      .google.cloud.discoveryengine.v1beta.SearchRequest.NaturalLanguageQueryUnderstandingSpec natural_language_query_understanding_spec = 28;
      Specified by:
      getNaturalLanguageQueryUnderstandingSpecOrBuilder in interface SearchRequestOrBuilder

    • hasSearchAsYouTypeSpec

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

    • getSearchAsYouTypeSpec

      public SearchRequest.SearchAsYouTypeSpec getSearchAsYouTypeSpec()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
      Specified by:
      getSearchAsYouTypeSpec in interface SearchRequestOrBuilder
      Returns:
      The searchAsYouTypeSpec.

    • setSearchAsYouTypeSpec

      public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • setSearchAsYouTypeSpec

      public SearchRequest.Builder setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.Builder builderForValue)
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • mergeSearchAsYouTypeSpec

      public SearchRequest.Builder mergeSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec value)
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • clearSearchAsYouTypeSpec

      public SearchRequest.Builder clearSearchAsYouTypeSpec()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • getSearchAsYouTypeSpecBuilder

      public SearchRequest.SearchAsYouTypeSpec.Builder getSearchAsYouTypeSpecBuilder()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;

    • getSearchAsYouTypeSpecOrBuilder

      public SearchRequest.SearchAsYouTypeSpecOrBuilder getSearchAsYouTypeSpecOrBuilder()
       Search as you type configuration. Only supported for the
 [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA]
 vertical.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SearchAsYouTypeSpec search_as_you_type_spec = 31;
      Specified by:
      getSearchAsYouTypeSpecOrBuilder in interface SearchRequestOrBuilder

    • getSession

      public String getSession()
       The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the 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) = { ... }
      Specified by:
      getSession in interface SearchRequestOrBuilder
      Returns:
      The session.

    • getSessionBytes

      public 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) = { ... }
      Specified by:
      getSessionBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for session.

    • setSession

      public SearchRequest.Builder setSession(String value)
       The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the 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) = { ... }
      Parameters:
      value - The session to set.
      Returns:
      This builder for chaining.

    • clearSession

      public SearchRequest.Builder clearSession()
       The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the 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:
      This builder for chaining.

    • setSessionBytes

      public SearchRequest.Builder setSessionBytes(com.google.protobuf.ByteString value)
       The session resource name. Optional.

 Session allows users to do multi-turn /search API calls or coordination
 between /search API calls and /answer API calls.

 Example #1 (multi-turn /search API calls):
 Call /search API with the 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) = { ... }
      Parameters:
      value - The bytes for session to set.
      Returns:
      This builder for chaining.

    • hasSessionSpec

      public boolean hasSessionSpec()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
      Specified by:
      hasSessionSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the sessionSpec field is set.

    • getSessionSpec

      public SearchRequest.SessionSpec getSessionSpec()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
      Specified by:
      getSessionSpec in interface SearchRequestOrBuilder
      Returns:
      The sessionSpec.

    • setSessionSpec

      public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec value)
       Session specification.

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

    • setSessionSpec

      public SearchRequest.Builder setSessionSpec(SearchRequest.SessionSpec.Builder builderForValue)
       Session specification.

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

    • mergeSessionSpec

      public SearchRequest.Builder mergeSessionSpec(SearchRequest.SessionSpec value)
       Session specification.

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

    • clearSessionSpec

      public SearchRequest.Builder clearSessionSpec()
       Session specification.

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

    • getSessionSpecBuilder

      public SearchRequest.SessionSpec.Builder getSessionSpecBuilder()
       Session specification.

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

    • getSessionSpecOrBuilder

      public SearchRequest.SessionSpecOrBuilder getSessionSpecOrBuilder()
       Session specification.

 Can be used only when `session` is set.
      .google.cloud.discoveryengine.v1beta.SearchRequest.SessionSpec session_spec = 42;
      Specified by:
      getSessionSpecOrBuilder in interface SearchRequestOrBuilder

    • getRelevanceThresholdValue

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

 Default to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Specified by:
      getRelevanceThresholdValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for relevanceThreshold.

    • setRelevanceThresholdValue

      public SearchRequest.Builder setRelevanceThresholdValue(int value)
       The relevance threshold of the search results.

 Default to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Parameters:
      value - The enum numeric value on the wire for relevanceThreshold to set.
      Returns:
      This builder for chaining.

    • getRelevanceThreshold

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

 Default to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Specified by:
      getRelevanceThreshold in interface SearchRequestOrBuilder
      Returns:
      The relevanceThreshold.

    • setRelevanceThreshold

      public SearchRequest.Builder setRelevanceThreshold(SearchRequest.RelevanceThreshold value)
       The relevance threshold of the search results.

 Default to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Parameters:
      value - The relevanceThreshold to set.
      Returns:
      This builder for chaining.

    • clearRelevanceThreshold

      public SearchRequest.Builder clearRelevanceThreshold()
       The relevance threshold of the search results.

 Default to Google defined threshold, leveraging a balance of
 precision and recall to deliver both highly accurate results and
 comprehensive coverage of relevant information.
      .google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold relevance_threshold = 44;
      Returns:
      This builder for chaining.

    • hasPersonalizationSpec

      public boolean hasPersonalizationSpec()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;
      Specified by:
      hasPersonalizationSpec in interface SearchRequestOrBuilder
      Returns:
      Whether the personalizationSpec field is set.

    • getPersonalizationSpec

      public SearchRequest.PersonalizationSpec getPersonalizationSpec()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;
      Specified by:
      getPersonalizationSpec in interface SearchRequestOrBuilder
      Returns:
      The personalizationSpec.

    • setPersonalizationSpec

      public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec value)
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;

    • setPersonalizationSpec

      public SearchRequest.Builder setPersonalizationSpec(SearchRequest.PersonalizationSpec.Builder builderForValue)
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;

    • mergePersonalizationSpec

      public SearchRequest.Builder mergePersonalizationSpec(SearchRequest.PersonalizationSpec value)
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;

    • clearPersonalizationSpec

      public SearchRequest.Builder clearPersonalizationSpec()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;

    • getPersonalizationSpecBuilder

      public SearchRequest.PersonalizationSpec.Builder getPersonalizationSpecBuilder()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;

    • getPersonalizationSpecOrBuilder

      public SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()
       The specification for personalization.

 Notice that if both
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec]
 and
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 are set,
 [SearchRequest.personalization_spec][google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec]
 overrides
 [ServingConfig.personalization_spec][google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec].
      .google.cloud.discoveryengine.v1beta.SearchRequest.PersonalizationSpec personalization_spec = 46;
      Specified by:
      getPersonalizationSpecOrBuilder in interface SearchRequestOrBuilder