com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams
extends com.google.api.client.json.GenericJson

Search parameters.

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
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	clone()
GoogleCloudDiscoveryengineV1SearchRequestBoostSpec	getBoostSpec() Boost specification to boost certain documents in search results which may affect the answer query response.
List<GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec>	getDataStoreSpecs() Specs defining dataStores to filter on in a search call and configurations for those dataStores.
String	getFilter() The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
Integer	getMaxReturnResults() Number of search results to return.
String	getOrderBy() The order in which documents are returned.
String	getSearchResultMode() Specifies the search result mode.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	setBoostSpec(GoogleCloudDiscoveryengineV1SearchRequestBoostSpec boostSpec) Boost specification to boost certain documents in search results which may affect the answer query response.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec> dataStoreSpecs) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	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.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	setMaxReturnResults(Integer maxReturnResults) Number of search results to return.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	setOrderBy(String orderBy) The order in which documents are returned.
GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams	setSearchResultMode(String searchResultMode) Specifies the search result mode.

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

GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams()

Method Detail

getBoostSpec

public GoogleCloudDiscoveryengineV1SearchRequestBoostSpec getBoostSpec()

Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)

Returns:

value or null for none

setBoostSpec

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams setBoostSpec(GoogleCloudDiscoveryengineV1SearchRequestBoostSpec boostSpec)

Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)

Parameters:

boostSpec - boostSpec or null for none

getDataStoreSpecs

public List<GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec> 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 GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams setDataStoreSpecs(List<GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec> 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

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. This will be used to filter search results which may affect the Answer response. 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 customers 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 GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams 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. This will be used to filter search results which may affect the Answer response. 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 customers 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

getMaxReturnResults

public Integer getMaxReturnResults()

Number of search results to return. The default value is 10.

Returns:

value or null for none

setMaxReturnResults

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams setMaxReturnResults(Integer maxReturnResults)

Number of search results to return. The default value is 10.

Parameters:

maxReturnResults - maxReturnResults 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, see [Ordering](https://cloud.google.com/retail/docs/filter-and- order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

Returns:

value or null for none

setOrderBy

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams 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, see [Ordering](https://cloud.google.com/retail/docs/filter-and- order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

Parameters:

orderBy - orderBy or null for none

getSearchResultMode

public String getSearchResultMode()

Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app- builder/docs/parse-chunk-documents)

Returns:

value or null for none

setSearchResultMode

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams setSearchResultMode(String searchResultMode)

Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app- builder/docs/parse-chunk-documents)

Parameters:

searchResultMode - searchResultMode or null for none

set

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams set(String fieldName,
                                                                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams clone()

Overrides:

clone in class com.google.api.client.json.GenericJson