GoogleCloudDiscoveryengineV1alphaSearchRequest (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaSearchRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1alphaSearchRequest
extends com.google.api.client.json.GenericJson
```
Request message for SearchService.Search method.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1alphaSearchRequest()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1alphaSearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`clone()`
`GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec`	`getBoostSpec()` Boost specification to boost certain documents.
`String`	`getBranch()` The branch resource name, such as `projects/locations/global/collections/default_collection/dat aStores/default_data_store/branches/0`.
`String`	`getCanonicalFilter()` The default filter that is applied when a user performs a search without checking any filters on the search page.
`GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec`	`getContentSearchSpec()` A specification for configuring the behavior of content search.
`List<GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec>`	`getCrowdingSpecs()` Optional.
`GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec`	`getCustomFineTuningSpec()` Custom fine tuning configs.
`GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams`	`getCustomRankingParams()` Optional.
`List<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>`	`getDataStoreSpecs()` Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
`GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec`	`getDisplaySpec()` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec`	`getEmbeddingSpec()` Uses the provided embedding to do additional semantic document retrieval.
`String`	`getEntity()` Optional.
`List<GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec>`	`getFacetSpecs()` Facet specifications for faceted search.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery`	`getImageQuery()` Raw image query.
`String`	`getLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec`	`getNaturalLanguageQueryUnderstandingSpec()` Optional.
`Integer`	`getNumResultsPerDataStore()` Optional.
`Integer`	`getOffset()` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results.
`Integer`	`getOneBoxPageSize()` The maximum number of results to return for OneBox.
`String`	`getOrderBy()` The order in which documents are returned.
`List<String>`	`getPageCategories()` Optional.
`Integer`	`getPageSize()` Maximum number of Documents to return.
`String`	`getPageToken()` A page token received from a previous SearchService.Search call.
`Map<String,Object>`	`getParams()` Additional search parameters.
`GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec`	`getPersonalizationSpec()` The specification for personalization.
`String`	`getQuery()` Raw search query.
`GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec`	`getQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`String`	`getRankingExpression()` Optional.
`String`	`getRankingExpressionBackend()` Optional.
`String`	`getRegionCode()` The Unicode country/region code (CLDR) of a location, such as "US" and "419".
`GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec`	`getRelevanceFilterSpec()` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec`	`getRelevanceScoreSpec()` Optional.
`String`	`getRelevanceThreshold()` The global relevance threshold of the search results.
`Boolean`	`getSafeSearch()` Whether to turn on safe search.
`GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec`	`getSearchAddonSpec()` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec`	`getSearchAsYouTypeSpec()` Search as you type configuration.
`String`	`getServingConfig()` Required.
`String`	`getSession()` The session resource name.
`GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec`	`getSessionSpec()` Session specification.
`GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec`	`getSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`Boolean`	`getUseLatestData()` Uses the Engine, ServingConfig and Control freshly read from the database.
`GoogleCloudDiscoveryengineV1alphaUserInfo`	`getUserInfo()` Information about the end user.
`Map<String,String>`	`getUserLabels()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`String`	`getUserPseudoId()` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec boostSpec)` Boost specification to boost certain documents.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setBranch(String branch)` The branch resource name, such as `projects/locations/global/collections/default_collection/dat aStores/default_data_store/branches/0`.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setCanonicalFilter(String canonicalFilter)` The default filter that is applied when a user performs a search without checking any filters on the search page.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setContentSearchSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec contentSearchSpec)` A specification for configuring the behavior of content search.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setCrowdingSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec> crowdingSpecs)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setCustomFineTuningSpec(GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec customFineTuningSpec)` Custom fine tuning configs.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setCustomRankingParams(GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams customRankingParams)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec> dataStoreSpecs)` Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setDisplaySpec(GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec displaySpec)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setEmbeddingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec embeddingSpec)` Uses the provided embedding to do additional semantic document retrieval.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setEntity(String entity)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setFacetSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec> facetSpecs)` Facet specifications for faceted search.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setFilter(String filter)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setImageQuery(GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery imageQuery)` Raw image query.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setLanguageCode(String languageCode)` The BCP-47 language code, such as "en-US" or "sr-Latn".
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec naturalLanguageQueryUnderstandingSpec)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setNumResultsPerDataStore(Integer numResultsPerDataStore)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setOffset(Integer offset)` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setOneBoxPageSize(Integer oneBoxPageSize)` The maximum number of results to return for OneBox.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setOrderBy(String orderBy)` The order in which documents are returned.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setPageCategories(List<String> pageCategories)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setPageSize(Integer pageSize)` Maximum number of Documents to return.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setPageToken(String pageToken)` A page token received from a previous SearchService.Search call.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setParams(Map<String,Object> params)` Additional search parameters.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setPersonalizationSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec personalizationSpec)` The specification for personalization.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setQuery(String query)` Raw search query.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setQueryExpansionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec queryExpansionSpec)` The query expansion specification that specifies the conditions under which query expansion occurs.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRankingExpression(String rankingExpression)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRankingExpressionBackend(String rankingExpressionBackend)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRegionCode(String regionCode)` The Unicode country/region code (CLDR) of a location, such as "US" and "419".
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRelevanceFilterSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec relevanceFilterSpec)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRelevanceScoreSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec relevanceScoreSpec)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setRelevanceThreshold(String relevanceThreshold)` The global relevance threshold of the search results.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSafeSearch(Boolean safeSearch)` Whether to turn on safe search.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSearchAddonSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec searchAddonSpec)` Optional.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec searchAsYouTypeSpec)` Search as you type configuration.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setServingConfig(String servingConfig)` Required.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSession(String session)` The session resource name.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSessionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec sessionSpec)` Session specification.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec spellCorrectionSpec)` The spell correction specification that specifies the mode under which spell correction takes effect.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setUseLatestData(Boolean useLatestData)` Uses the Engine, ServingConfig and Control freshly read from the database.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setUserInfo(GoogleCloudDiscoveryengineV1alphaUserInfo userInfo)` Information about the end user.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setUserLabels(Map<String,String> userLabels)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`GoogleCloudDiscoveryengineV1alphaSearchRequest`	`setUserPseudoId(String userPseudoId)` Optional.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1alphaSearchRequest
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest()
```
- Method Detail
  - getBoostSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec 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)
    
    Returns:
    
    value or null for none
  - setBoostSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setBoostSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec boostSpec)
```
    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)
    
    Parameters:
    
    boostSpec - boostSpec or null for none
  - getBranch
```
public String getBranch()
```
    The branch resource name, such as `projects/locations/global/collections/default_collection/dat aStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
    
    Returns:
    
    value or null for none
  - setBranch
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setBranch(String branch)
```
    The branch resource name, such as `projects/locations/global/collections/default_collection/dat aStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
    
    Parameters:
    
    branch - branch or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setCanonicalFilter
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setCanonicalFilter(String canonicalFilter)
```
    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.
    
    Parameters:
    
    canonicalFilter - canonicalFilter or null for none
  - getContentSearchSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec getContentSearchSpec()
```
    A specification for configuring the behavior of content search.
    
    Returns:
    
    value or null for none
  - setContentSearchSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setContentSearchSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec contentSearchSpec)
```
    A specification for configuring the behavior of content search.
    
    Parameters:
    
    contentSearchSpec - contentSearchSpec or null for none
  - getCrowdingSpecs
```
public List<GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec> getCrowdingSpecs()
```
    Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
    
    Returns:
    
    value or null for none
  - setCrowdingSpecs
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setCrowdingSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec> crowdingSpecs)
```
    Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = "color" and `max_count` = 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.
    
    Parameters:
    
    crowdingSpecs - crowdingSpecs or null for none
  - getCustomFineTuningSpec
```
public GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec getCustomFineTuningSpec()
```
    Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
    
    Returns:
    
    value or null for none
  - setCustomFineTuningSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setCustomFineTuningSpec(GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec customFineTuningSpec)
```
    Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
    
    Parameters:
    
    customFineTuningSpec - customFineTuningSpec or null for none
  - getCustomRankingParams
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams getCustomRankingParams()
```
    Optional. Optional configuration for the Custom Ranking feature.
    
    Returns:
    
    value or null for none
  - setCustomRankingParams
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setCustomRankingParams(GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams customRankingParams)
```
    Optional. Optional configuration for the Custom Ranking feature.
    
    Parameters:
    
    customRankingParams - customRankingParams or null for none
  - getDataStoreSpecs
```
public List<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec> getDataStoreSpecs()
```
    Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
    
    Returns:
    
    value or null for none
  - setDataStoreSpecs
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec> dataStoreSpecs)
```
    Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.
    
    Parameters:
    
    dataStoreSpecs - dataStoreSpecs or null for none
  - getDisplaySpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec getDisplaySpec()
```
    Optional. Config for display feature, like match highlighting on search results.
    
    Returns:
    
    value or null for none
  - setDisplaySpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setDisplaySpec(GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec displaySpec)
```
    Optional. Config for display feature, like match highlighting on search results.
    
    Parameters:
    
    displaySpec - displaySpec or null for none
  - getEmbeddingSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec getEmbeddingSpec()
```
    Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
    
    Returns:
    
    value or null for none
  - setEmbeddingSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setEmbeddingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec embeddingSpec)
```
    Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
    
    Parameters:
    
    embeddingSpec - embeddingSpec or null for none
  - getEntity
```
public String getEntity()
```
    Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.
    
    Returns:
    
    value or null for none
  - setEntity
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setEntity(String entity)
```
    Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.
    
    Parameters:
    
    entity - entity or null for none
  - getFacetSpecs
```
public List<GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec> getFacetSpecs()
```
    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.
    
    Returns:
    
    value or null for none
  - setFacetSpecs
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setFacetSpecs(List<GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec> facetSpecs)
```
    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.
    
    Parameters:
    
    facetSpecs - facetSpecs or null for none
  - 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)
    
    Returns:
    
    value or null for none
  - setFilter
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setFilter(String filter)
```
    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)
    
    Parameters:
    
    filter - filter or null for none
  - getImageQuery
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery getImageQuery()
```
    Raw image query.
    
    Returns:
    
    value or null for none
  - setImageQuery
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setImageQuery(GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery imageQuery)
```
    Raw image query.
    
    Parameters:
    
    imageQuery - imageQuery or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setLanguageCode
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setLanguageCode(String languageCode)
```
    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.
    
    Parameters:
    
    languageCode - languageCode or null for none
  - getNaturalLanguageQueryUnderstandingSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()
```
    Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language- queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
    
    Returns:
    
    value or null for none
  - setNaturalLanguageQueryUnderstandingSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec naturalLanguageQueryUnderstandingSpec)
```
    Optional. Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language- queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
    
    Parameters:
    
    naturalLanguageQueryUnderstandingSpec - naturalLanguageQueryUnderstandingSpec or null for none
  - getNumResultsPerDataStore
```
public Integer getNumResultsPerDataStore()
```
    Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit.
    
    Returns:
    
    value or null for none
  - setNumResultsPerDataStore
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setNumResultsPerDataStore(Integer numResultsPerDataStore)
```
    Optional. The maximum number of results to retrieve from each data store. If not specified, it will use the SearchRequest.DataStoreSpec.num_results if provided, otherwise there is no limit.
    
    Parameters:
    
    numResultsPerDataStore - numResultsPerDataStore or null for none
  - getOffset
```
public Integer getOffset()
```
    A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
    
    Returns:
    
    value or null for none
  - setOffset
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setOffset(Integer offset)
```
    A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
    
    Parameters:
    
    offset - offset or null for none
  - getOneBoxPageSize
```
public Integer getOneBoxPageSize()
```
    The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
    
    Returns:
    
    value or null for none
  - setOneBoxPageSize
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setOneBoxPageSize(Integer oneBoxPageSize)
```
    The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
    
    Parameters:
    
    oneBoxPageSize - oneBoxPageSize or null for none
  - getOrderBy
```
public String getOrderBy()
```
    The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](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.
    
    Returns:
    
    value or null for none
  - setOrderBy
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setOrderBy(String orderBy)
```
    The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](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.
    
    Parameters:
    
    orderBy - orderBy or null for none
  - getPageCategories
```
public List<String> getPageCategories()
```
    Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition`
    
    Returns:
    
    value or null for none
  - setPageCategories
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setPageCategories(List<String> pageCategories)
```
    Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition`
    
    Parameters:
    
    pageCategories - pageCategories or null for none
  - getPageSize
```
public Integer getPageSize()
```
    Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, 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.
    
    Returns:
    
    value or null for none
  - setPageSize
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setPageSize(Integer pageSize)
```
    Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, 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.
    
    Parameters:
    
    pageSize - pageSize or null for none
  - getPageToken
```
public String getPageToken()
```
    A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Returns:
    
    value or null for none
  - setPageToken
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setPageToken(String pageToken)
```
    A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Parameters:
    
    pageToken - pageToken or null for none
  - getParams
```
public Map<String,Object> getParams()
```
    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`
    
    Returns:
    
    value or null for none
  - setParams
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setParams(Map<String,Object> params)
```
    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`
    
    Parameters:
    
    params - params or null for none
  - getPersonalizationSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec getPersonalizationSpec()
```
    The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.
    
    Returns:
    
    value or null for none
  - setPersonalizationSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setPersonalizationSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec personalizationSpec)
```
    The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.
    
    Parameters:
    
    personalizationSpec - personalizationSpec or null for none
  - getQuery
```
public String getQuery()
```
    Raw search query.
    
    Returns:
    
    value or null for none
  - setQuery
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setQuery(String query)
```
    Raw search query.
    
    Parameters:
    
    query - query or null for none
  - getQueryExpansionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec getQueryExpansionSpec()
```
    The query expansion specification that specifies the conditions under which query expansion occurs.
    
    Returns:
    
    value or null for none
  - setQueryExpansionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setQueryExpansionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec queryExpansionSpec)
```
    The query expansion specification that specifies the conditions under which query expansion occurs.
    
    Parameters:
    
    queryExpansionSpec - queryExpansionSpec or null for none
  - getRankingExpression
```
public String getRankingExpression()
```
    Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides 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 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 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
    
    Returns:
    
    value or null for none
  - setRankingExpression
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRankingExpression(String rankingExpression)
```
    Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides 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 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 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
    
    Parameters:
    
    rankingExpression - rankingExpression or null for none
  - getRankingExpressionBackend
```
public String getRankingExpressionBackend()
```
    Optional. The backend to use for the ranking expression evaluation.
    
    Returns:
    
    value or null for none
  - setRankingExpressionBackend
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRankingExpressionBackend(String rankingExpressionBackend)
```
    Optional. The backend to use for the ranking expression evaluation.
    
    Parameters:
    
    rankingExpressionBackend - rankingExpressionBackend or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setRegionCode
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRegionCode(String regionCode)
```
    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.
    
    Parameters:
    
    regionCode - regionCode or null for none
  - getRelevanceFilterSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec getRelevanceFilterSpec()
```
    Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
    
    Returns:
    
    value or null for none
  - setRelevanceFilterSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRelevanceFilterSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec relevanceFilterSpec)
```
    Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
    
    Parameters:
    
    relevanceFilterSpec - relevanceFilterSpec or null for none
  - getRelevanceScoreSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec getRelevanceScoreSpec()
```
    Optional. The specification for returning the relevance score.
    
    Returns:
    
    value or null for none
  - setRelevanceScoreSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRelevanceScoreSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec relevanceScoreSpec)
```
    Optional. The specification for returning the relevance score.
    
    Parameters:
    
    relevanceScoreSpec - relevanceScoreSpec or null for none
  - getRelevanceThreshold
```
public String getRelevanceThreshold()
```
    The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
    
    Returns:
    
    value or null for none
  - setRelevanceThreshold
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setRelevanceThreshold(String relevanceThreshold)
```
    The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
    
    Parameters:
    
    relevanceThreshold - relevanceThreshold or null for none
  - getSafeSearch
```
public Boolean getSafeSearch()
```
    Whether to turn on safe search. This is only supported for website search.
    
    Returns:
    
    value or null for none
  - setSafeSearch
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSafeSearch(Boolean safeSearch)
```
    Whether to turn on safe search. This is only supported for website search.
    
    Parameters:
    
    safeSearch - safeSearch or null for none
  - getSearchAddonSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec getSearchAddonSpec()
```
    Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
    
    Returns:
    
    value or null for none
  - setSearchAddonSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSearchAddonSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec searchAddonSpec)
```
    Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. This field is only supported for search requests.
    
    Parameters:
    
    searchAddonSpec - searchAddonSpec or null for none
  - getSearchAsYouTypeSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec getSearchAsYouTypeSpec()
```
    Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
    
    Returns:
    
    value or null for none
  - setSearchAsYouTypeSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec searchAsYouTypeSpec)
```
    Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
    
    Parameters:
    
    searchAsYouTypeSpec - searchAsYouTypeSpec or null for none
  - getServingConfig
```
public String getServingConfig()
```
    Required. The resource name of the Search serving config, such as `projects/locations/global/co llections/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locat ions/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.
    
    Returns:
    
    value or null for none
  - setServingConfig
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setServingConfig(String servingConfig)
```
    Required. The resource name of the Search serving config, such as `projects/locations/global/co llections/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locat ions/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.
    
    Parameters:
    
    servingConfig - servingConfig or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSession
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSession(String session)
```
    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.
    
    Parameters:
    
    session - session or null for none
  - getSessionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec getSessionSpec()
```
    Session specification. Can be used only when `session` is set.
    
    Returns:
    
    value or null for none
  - setSessionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSessionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec sessionSpec)
```
    Session specification. Can be used only when `session` is set.
    
    Parameters:
    
    sessionSpec - sessionSpec or null for none
  - getSpellCorrectionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec getSpellCorrectionSpec()
```
    The spell correction specification that specifies the mode under which spell correction takes effect.
    
    Returns:
    
    value or null for none
  - setSpellCorrectionSpec
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec spellCorrectionSpec)
```
    The spell correction specification that specifies the mode under which spell correction takes effect.
    
    Parameters:
    
    spellCorrectionSpec - spellCorrectionSpec or null for none
  - getUseLatestData
```
public Boolean getUseLatestData()
```
    Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.
    
    Returns:
    
    value or null for none
  - setUseLatestData
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setUseLatestData(Boolean useLatestData)
```
    Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users.
    
    Parameters:
    
    useLatestData - useLatestData or null for none
  - getUserInfo
```
public GoogleCloudDiscoveryengineV1alphaUserInfo getUserInfo()
```
    Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics.
    
    Returns:
    
    value or null for none
  - setUserInfo
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setUserInfo(GoogleCloudDiscoveryengineV1alphaUserInfo userInfo)
```
    Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics.
    
    Parameters:
    
    userInfo - userInfo or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    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.
    
    Returns:
    
    value or null for none
  - setUserLabels
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setUserLabels(Map<String,String> userLabels)
```
    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.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - getUserPseudoId
```
public String getUserPseudoId()
```
    Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Returns:
    
    value or null for none
  - setUserPseudoId
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest setUserPseudoId(String userPseudoId)
```
    Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Parameters:
    
    userPseudoId - userPseudoId or null for none
  - set
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest set(String fieldName,
                                                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1alphaSearchRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1alphaSearchRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1alphaSearchRequest

Method Detail

getBoostSpec

setBoostSpec

getBranch

setBranch

getCanonicalFilter

setCanonicalFilter

getContentSearchSpec

setContentSearchSpec

getCrowdingSpecs

setCrowdingSpecs

getCustomFineTuningSpec

setCustomFineTuningSpec

getCustomRankingParams

setCustomRankingParams

getDataStoreSpecs

setDataStoreSpecs

getDisplaySpec

setDisplaySpec

getEmbeddingSpec

setEmbeddingSpec

getEntity

setEntity

getFacetSpecs

setFacetSpecs

getFilter

setFilter

getImageQuery

setImageQuery

getLanguageCode

setLanguageCode

getNaturalLanguageQueryUnderstandingSpec

setNaturalLanguageQueryUnderstandingSpec

getNumResultsPerDataStore

setNumResultsPerDataStore

getOffset

setOffset

getOneBoxPageSize

setOneBoxPageSize

getOrderBy

setOrderBy

getPageCategories

setPageCategories

getPageSize

setPageSize

getPageToken

setPageToken

getParams

setParams

getPersonalizationSpec

setPersonalizationSpec

getQuery

setQuery

getQueryExpansionSpec

setQueryExpansionSpec

getRankingExpression

setRankingExpression

getRankingExpressionBackend

setRankingExpressionBackend

getRegionCode

setRegionCode

getRelevanceFilterSpec

setRelevanceFilterSpec

getRelevanceScoreSpec

setRelevanceScoreSpec

getRelevanceThreshold