GoogleCloudDiscoveryengineV1betaSearchRequest (Discovery Engine API v1-rev20240912-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.GoogleCloudDiscoveryengineV1betaSearchRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1betaSearchRequest
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

GoogleCloudDiscoveryengineV1betaSearchRequest()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1betaSearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`clone()`
`GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec`	`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.
`GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec`	`getContentSearchSpec()` A specification for configuring the behavior of content search.
`List<GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec>`	`getDataStoreSpecs()` Specs defining dataStores to filter on in a search call and configurations for those dataStores.
`GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec`	`getEmbeddingSpec()` Uses the provided embedding to do additional semantic document retrieval.
`List<GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec>`	`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.
`GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery`	`getImageQuery()` Raw image query.
`String`	`getLanguageCode()` The BCP-47 language code, such as "en-US" or "sr-Latn".
`GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec`	`getNaturalLanguageQueryUnderstandingSpec()` If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
`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.
`String`	`getOrderBy()` The order in which documents are returned.
`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.
`String`	`getQuery()` Raw search query.
`GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec`	`getQueryExpansionSpec()` The query expansion specification that specifies the conditions under which query expansion occurs.
`String`	`getRankingExpression()` The ranking expression controls the customized ranking on retrieval documents.
`String`	`getRegionCode()` The Unicode country/region code (CLDR) of a location, such as "US" and "419".
`String`	`getRelevanceThreshold()` The relevance threshold of the search results.
`Boolean`	`getSafeSearch()` Whether to turn on safe search.
`GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec`	`getSearchAsYouTypeSpec()` Search as you type configuration.
`String`	`getServingConfig()` Required.
`String`	`getSession()` The session resource name.
`GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec`	`getSessionSpec()` Session specification.
`GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec`	`getSpellCorrectionSpec()` The spell correction specification that specifies the mode under which spell correction takes effect.
`GoogleCloudDiscoveryengineV1betaUserInfo`	`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()` A unique identifier for tracking visitors.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setBoostSpec(GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec boostSpec)` Boost specification to boost certain documents.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setBranch(String branch)` The branch resource name, such as `projects/locations/global/collections/default_collection/dat aStores/default_data_store/branches/0`.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setCanonicalFilter(String canonicalFilter)` The default filter that is applied when a user performs a search without checking any filters on the search page.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setContentSearchSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec contentSearchSpec)` A specification for configuring the behavior of content search.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec> dataStoreSpecs)` Specs defining dataStores to filter on in a search call and configurations for those dataStores.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setEmbeddingSpec(GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec embeddingSpec)` Uses the provided embedding to do additional semantic document retrieval.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setFacetSpecs(List<GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec> facetSpecs)` Facet specifications for faceted search.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`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.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setImageQuery(GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery imageQuery)` Raw image query.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setLanguageCode(String languageCode)` The BCP-47 language code, such as "en-US" or "sr-Latn".
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec naturalLanguageQueryUnderstandingSpec)` If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`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.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setOrderBy(String orderBy)` The order in which documents are returned.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setPageSize(Integer pageSize)` Maximum number of Documents to return.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setPageToken(String pageToken)` A page token received from a previous SearchService.Search call.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setParams(Map<String,Object> params)` Additional search parameters.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setQuery(String query)` Raw search query.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setQueryExpansionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec queryExpansionSpec)` The query expansion specification that specifies the conditions under which query expansion occurs.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setRankingExpression(String rankingExpression)` The ranking expression controls the customized ranking on retrieval documents.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setRegionCode(String regionCode)` The Unicode country/region code (CLDR) of a location, such as "US" and "419".
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setRelevanceThreshold(String relevanceThreshold)` The relevance threshold of the search results.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setSafeSearch(Boolean safeSearch)` Whether to turn on safe search.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec searchAsYouTypeSpec)` Search as you type configuration.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setServingConfig(String servingConfig)` Required.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setSession(String session)` The session resource name.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setSessionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec sessionSpec)` Session specification.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec spellCorrectionSpec)` The spell correction specification that specifies the mode under which spell correction takes effect.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setUserInfo(GoogleCloudDiscoveryengineV1betaUserInfo userInfo)` Information about the end user.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`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.
`GoogleCloudDiscoveryengineV1betaSearchRequest`	`setUserPseudoId(String userPseudoId)` A unique identifier for tracking visitors.

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
  - GoogleCloudDiscoveryengineV1betaSearchRequest
```
public GoogleCloudDiscoveryengineV1betaSearchRequest()
```
- Method Detail
  - getBoostSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec 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 GoogleCloudDiscoveryengineV1betaSearchRequest setBoostSpec(GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec getContentSearchSpec()
```
    A specification for configuring the behavior of content search.
    
    Returns:
    
    value or null for none
  - setContentSearchSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setContentSearchSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec contentSearchSpec)
```
    A specification for configuring the behavior of content search.
    
    Parameters:
    
    contentSearchSpec - contentSearchSpec or null for none
  - getDataStoreSpecs
```
public List<GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec> getDataStoreSpecs()
```
    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.
    
    Returns:
    
    value or null for none
  - setDataStoreSpecs
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec> dataStoreSpecs)
```
    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.
    
    Parameters:
    
    dataStoreSpecs - dataStoreSpecs or null for none
  - getEmbeddingSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec 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 GoogleCloudDiscoveryengineV1betaSearchRequest setEmbeddingSpec(GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec 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
  - getFacetSpecs
```
public List<GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec> 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 GoogleCloudDiscoveryengineV1betaSearchRequest setFacetSpecs(List<GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec> 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery getImageQuery()
```
    Raw image query.
    
    Returns:
    
    value or null for none
  - setImageQuery
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setImageQuery(GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec getNaturalLanguageQueryUnderstandingSpec()
```
    If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
    
    Returns:
    
    value or null for none
  - setNaturalLanguageQueryUnderstandingSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setNaturalLanguageQueryUnderstandingSpec(GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec naturalLanguageQueryUnderstandingSpec)
```
    If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
    
    Parameters:
    
    naturalLanguageQueryUnderstandingSpec - naturalLanguageQueryUnderstandingSpec 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.
    
    Returns:
    
    value or null for none
  - setOffset
```
public GoogleCloudDiscoveryengineV1betaSearchRequest 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.
    
    Parameters:
    
    offset - offset 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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
  - 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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
  - getQuery
```
public String getQuery()
```
    Raw search query.
    
    Returns:
    
    value or null for none
  - setQuery
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setQuery(String query)
```
    Raw search query.
    
    Parameters:
    
    query - query or null for none
  - getQueryExpansionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec getQueryExpansionSpec()
```
    The query expansion specification that specifies the conditions under which query expansion occurs.
    
    Returns:
    
    value or null for none
  - setQueryExpansionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setQueryExpansionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec 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()
```
    The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is 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)`.
    
    Returns:
    
    value or null for none
  - setRankingExpression
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setRankingExpression(String rankingExpression)
```
    The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is 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)`.
    
    Parameters:
    
    rankingExpression - rankingExpression 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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
  - getRelevanceThreshold
```
public String 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.
    
    Returns:
    
    value or null for none
  - setRelevanceThreshold
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setRelevanceThreshold(String relevanceThreshold)
```
    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.
    
    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 GoogleCloudDiscoveryengineV1betaSearchRequest setSafeSearch(Boolean safeSearch)
```
    Whether to turn on safe search. This is only supported for website search.
    
    Parameters:
    
    safeSearch - safeSearch or null for none
  - getSearchAsYouTypeSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec getSearchAsYouTypeSpec()
```
    Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
    
    Returns:
    
    value or null for none
  - setSearchAsYouTypeSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setSearchAsYouTypeSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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): 1. Call /search API with the auto-session mode (see below). 2. 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): 1. Call /search API with the auto-session mode (see below). 2. 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. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. 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.
    
    Returns:
    
    value or null for none
  - setSession
```
public GoogleCloudDiscoveryengineV1betaSearchRequest 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): 1. Call /search API with the auto-session mode (see below). 2. 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): 1. Call /search API with the auto-session mode (see below). 2. 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. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. 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.
    
    Parameters:
    
    session - session or null for none
  - getSessionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec getSessionSpec()
```
    Session specification. Can be used only when `session` is set.
    
    Returns:
    
    value or null for none
  - setSessionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setSessionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec sessionSpec)
```
    Session specification. Can be used only when `session` is set.
    
    Parameters:
    
    sessionSpec - sessionSpec or null for none
  - getSpellCorrectionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec getSpellCorrectionSpec()
```
    The spell correction specification that specifies the mode under which spell correction takes effect.
    
    Returns:
    
    value or null for none
  - setSpellCorrectionSpec
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setSpellCorrectionSpec(GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec spellCorrectionSpec)
```
    The spell correction specification that specifies the mode under which spell correction takes effect.
    
    Parameters:
    
    spellCorrectionSpec - spellCorrectionSpec or null for none
  - getUserInfo
```
public GoogleCloudDiscoveryengineV1betaUserInfo getUserInfo()
```
    Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
    
    Returns:
    
    value or null for none
  - setUserInfo
```
public GoogleCloudDiscoveryengineV1betaSearchRequest setUserInfo(GoogleCloudDiscoveryengineV1betaUserInfo userInfo)
```
    Information about the end user. Highly recommended for analytics. 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 GoogleCloudDiscoveryengineV1betaSearchRequest 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()
```
    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 GoogleCloudDiscoveryengineV1betaSearchRequest setUserPseudoId(String userPseudoId)
```
    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 GoogleCloudDiscoveryengineV1betaSearchRequest set(String fieldName,
                                                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1betaSearchRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1betaSearchRequest

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

GoogleCloudDiscoveryengineV1betaSearchRequest

Method Detail

getBoostSpec

setBoostSpec

getBranch

setBranch

getCanonicalFilter

setCanonicalFilter

getContentSearchSpec

setContentSearchSpec

getDataStoreSpecs

setDataStoreSpecs

getEmbeddingSpec

setEmbeddingSpec

getFacetSpecs

setFacetSpecs

getFilter

setFilter

getImageQuery

setImageQuery

getLanguageCode

setLanguageCode

getNaturalLanguageQueryUnderstandingSpec

setNaturalLanguageQueryUnderstandingSpec

getOffset

setOffset

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

getParams

setParams

getQuery

setQuery

getQueryExpansionSpec

setQueryExpansionSpec

getRankingExpression

setRankingExpression

getRegionCode

setRegionCode

getRelevanceThreshold

setRelevanceThreshold

getSafeSearch

setSafeSearch

getSearchAsYouTypeSpec

setSearchAsYouTypeSpec

getServingConfig

setServingConfig

getSession

setSession

getSessionSpec

setSessionSpec

getSpellCorrectionSpec

setSpellCorrectionSpec

getUserInfo

setUserInfo

getUserLabels

setUserLabels

getUserPseudoId

setUserPseudoId

set

clone