com.google.cloud.discoveryengine.v1alpha

Interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AnswerQueryRequest.SearchSpec.SearchParams, AnswerQueryRequest.SearchSpec.SearchParams.Builder

Enclosing class:

AnswerQueryRequest.SearchSpec

public static interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchRequest.BoostSpec	getBoostSpec() Boost specification to boost certain documents in search results which may affect the answer query response.
SearchRequest.BoostSpecOrBuilder	getBoostSpecOrBuilder() Boost specification to boost certain documents in search results which may affect the answer query response.
CustomFineTuningSpec	getCustomFineTuningSpec() Custom fine tuning configs.
CustomFineTuningSpecOrBuilder	getCustomFineTuningSpecOrBuilder() Custom fine tuning configs.
SearchRequest.DataStoreSpec	getDataStoreSpecs(int index) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
int	getDataStoreSpecsCount() Specs defining dataStores to filter on in a search call and configurations for those dataStores.
List<SearchRequest.DataStoreSpec>	getDataStoreSpecsList() Specs defining dataStores to filter on in a search call and configurations for those dataStores.
SearchRequest.DataStoreSpecOrBuilder	getDataStoreSpecsOrBuilder(int index) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
List<? extends SearchRequest.DataStoreSpecOrBuilder>	getDataStoreSpecsOrBuilderList() 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.
com.google.protobuf.ByteString	getFilterBytes() The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
int	getMaxReturnResults() Number of search results to return.
String	getOrderBy() The order in which documents are returned.
com.google.protobuf.ByteString	getOrderByBytes() The order in which documents are returned.
SearchRequest.ContentSearchSpec.SearchResultMode	getSearchResultMode() Specifies the search result mode.
int	getSearchResultModeValue() Specifies the search result mode.
boolean	hasBoostSpec() Boost specification to boost certain documents in search results which may affect the answer query response.
boolean	hasCustomFineTuningSpec() Custom fine tuning configs.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getMaxReturnResults

int getMaxReturnResults()

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

int32 max_return_results = 1;

Returns:

The maxReturnResults.

getFilter

String getFilter()

 The filter syntax consists of an expression language for constructing
 a predicate from one or more fields of the documents being filtered.
 Filter expression is case-sensitive. 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)
 

string filter = 2;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 The filter syntax consists of an expression language for constructing
 a predicate from one or more fields of the documents being filtered.
 Filter expression is case-sensitive. 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)
 

string filter = 2;

Returns:

The bytes for filter.

hasBoostSpec

boolean hasBoostSpec()

 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)
 

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 3;

Returns:

Whether the boostSpec field is set.

getBoostSpec

SearchRequest.BoostSpec 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)
 

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 3;

Returns:

The boostSpec.

getBoostSpecOrBuilder

SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

 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)
 

.google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec boost_spec = 3;

getOrderBy

String getOrderBy()

 The order in which documents are returned. Documents can be ordered
 by a field in an
 [Document][google.cloud.discoveryengine.v1alpha.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.
 

string order_by = 4;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 The order in which documents are returned. Documents can be ordered
 by a field in an
 [Document][google.cloud.discoveryengine.v1alpha.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.
 

string order_by = 4;

Returns:

The bytes for orderBy.

getSearchResultModeValue

int getSearchResultModeValue()

 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)
 

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;

Returns:

The enum numeric value on the wire for searchResultMode.

getSearchResultMode

SearchRequest.ContentSearchSpec.SearchResultMode 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)
 

.google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;

Returns:

The searchResultMode.

hasCustomFineTuningSpec

boolean hasCustomFineTuningSpec()

 Custom fine tuning configs.
 

.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;

Returns:

Whether the customFineTuningSpec field is set.

getCustomFineTuningSpec

CustomFineTuningSpec getCustomFineTuningSpec()

 Custom fine tuning configs.
 

.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;

Returns:

The customFineTuningSpec.

getCustomFineTuningSpecOrBuilder

CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()

 Custom fine tuning configs.
 

.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;

getDataStoreSpecsList

List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

 Specs defining dataStores to filter on in a search call and
 configurations for those dataStores. This is only considered for
 engines with multiple dataStores use case. For single dataStore within
 an engine, they should use the specs at the top level.
 

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec data_store_specs = 7;

getDataStoreSpecs

SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

 Specs defining dataStores to filter on in a search call and
 configurations for those dataStores. This is only considered for
 engines with multiple dataStores use case. For single dataStore within
 an engine, they should use the specs at the top level.
 

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec data_store_specs = 7;

getDataStoreSpecsCount

int getDataStoreSpecsCount()

 Specs defining dataStores to filter on in a search call and
 configurations for those dataStores. This is only considered for
 engines with multiple dataStores use case. For single dataStore within
 an engine, they should use the specs at the top level.
 

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec data_store_specs = 7;

getDataStoreSpecsOrBuilderList

List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Specs defining dataStores to filter on in a search call and
 configurations for those dataStores. This is only considered for
 engines with multiple dataStores use case. For single dataStore within
 an engine, they should use the specs at the top level.
 

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec data_store_specs = 7;

getDataStoreSpecsOrBuilder

SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Specs defining dataStores to filter on in a search call and
 configurations for those dataStores. This is only considered for
 engines with multiple dataStores use case. For single dataStore within
 an engine, they should use the specs at the top level.
 

repeated .google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpec data_store_specs = 7;