com.google.cloud.discoveryengine.v1alpha

Class AnswerQueryRequest.SearchSpec.SearchParams.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

com.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchParams.Builder

All Implemented Interfaces:

AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

AnswerQueryRequest.SearchSpec.SearchParams

public static final class AnswerQueryRequest.SearchSpec.SearchParams.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>
implements AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

 Search parameters.
 

Protobuf type google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchParams

Method Summary

Modifier and Type	Method and Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addDataStoreSpecs(SearchRequest.DataStoreSpec value) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
SearchRequest.DataStoreSpec.Builder	addDataStoreSpecsBuilder() Specs defining dataStores to filter on in a search call and configurations for those dataStores.
SearchRequest.DataStoreSpec.Builder	addDataStoreSpecsBuilder(int index) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AnswerQueryRequest.SearchSpec.SearchParams	build()
AnswerQueryRequest.SearchSpec.SearchParams	buildPartial()
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clear()
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearBoostSpec() Boost specification to boost certain documents in search results which may affect the answer query response.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearCustomFineTuningSpec() Custom fine tuning configs.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearDataStoreSpecs() Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearFilter() The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearMaxReturnResults() Number of search results to return.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearOrderBy() The order in which documents are returned.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clearSearchResultMode() Specifies the search result mode.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	clone()
SearchRequest.BoostSpec	getBoostSpec() Boost specification to boost certain documents in search results which may affect the answer query response.
SearchRequest.BoostSpec.Builder	getBoostSpecBuilder() 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.
CustomFineTuningSpec.Builder	getCustomFineTuningSpecBuilder() 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.
SearchRequest.DataStoreSpec.Builder	getDataStoreSpecsBuilder(int index) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
List<SearchRequest.DataStoreSpec.Builder>	getDataStoreSpecsBuilderList() 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.
AnswerQueryRequest.SearchSpec.SearchParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeBoostSpec(SearchRequest.BoostSpec value) Boost specification to boost certain documents in search results which may affect the answer query response.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeCustomFineTuningSpec(CustomFineTuningSpec value) Custom fine tuning configs.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeFrom(AnswerQueryRequest.SearchSpec.SearchParams other)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeFrom(com.google.protobuf.Message other)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	removeDataStoreSpecs(int index) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue) Boost specification to boost certain documents in search results which may affect the answer query response.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setBoostSpec(SearchRequest.BoostSpec value) Boost specification to boost certain documents in search results which may affect the answer query response.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setCustomFineTuningSpec(CustomFineTuningSpec.Builder builderForValue) Custom fine tuning configs.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setCustomFineTuningSpec(CustomFineTuningSpec value) Custom fine tuning configs.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value) Specs defining dataStores to filter on in a search call and configurations for those dataStores.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setFilter(String value) The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setFilterBytes(com.google.protobuf.ByteString value) The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setMaxReturnResults(int value) Number of search results to return.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setOrderBy(String value) The order in which documents are returned.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setOrderByBytes(com.google.protobuf.ByteString value) The order in which documents are returned.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setSearchResultMode(SearchRequest.ContentSearchSpec.SearchResultMode value) Specifies the search result mode.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setSearchResultModeValue(int value) Specifies the search result mode.
AnswerQueryRequest.SearchSpec.SearchParams.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

clear

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

getDefaultInstanceForType

public AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AnswerQueryRequest.SearchSpec.SearchParams build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AnswerQueryRequest.SearchSpec.SearchParams buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

setField

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

clearField

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

clearOneof

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

setRepeatedField

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                           int index,
                                                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

addRepeatedField

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

mergeFrom

public AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

mergeFrom

public AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeFrom(AnswerQueryRequest.SearchSpec.SearchParams other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

mergeFrom

public AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

Throws:

IOException

getMaxReturnResults

public int getMaxReturnResults()

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

int32 max_return_results = 1;

Specified by:

getMaxReturnResults in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The maxReturnResults.

setMaxReturnResults

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setMaxReturnResults(int value)

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

int32 max_return_results = 1;

Parameters:

value - The maxReturnResults to set.

Returns:

This builder for chaining.

clearMaxReturnResults

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearMaxReturnResults()

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

int32 max_return_results = 1;

Returns:

This builder for chaining.

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)
 

string filter = 2;

Specified by:

getFilter in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

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

Specified by:

getFilterBytes in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The bytes for filter.

setFilter

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setFilter(String value)

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearFilter()

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

This builder for chaining.

setFilterBytes

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

hasBoostSpec

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

Specified by:

hasBoostSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

Whether the boostSpec field is set.

getBoostSpec

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

Specified by:

getBoostSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The boostSpec.

setBoostSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setBoostSpec(SearchRequest.BoostSpec value)

 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;

setBoostSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

 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;

mergeBoostSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

 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;

clearBoostSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearBoostSpec()

 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;

getBoostSpecBuilder

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

 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;

getBoostSpecOrBuilder

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

Specified by:

getBoostSpecOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

getOrderBy

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

Specified by:

getOrderBy in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The orderBy.

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

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

Specified by:

getOrderByBytes in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The bytes for orderBy.

setOrderBy

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setOrderBy(String value)

 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;

Parameters:

value - The orderBy to set.

Returns:

This builder for chaining.

clearOrderBy

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearOrderBy()

 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:

This builder for chaining.

setOrderByBytes

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setOrderByBytes(com.google.protobuf.ByteString value)

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

Parameters:

value - The bytes for orderBy to set.

Returns:

This builder for chaining.

getSearchResultModeValue

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

Specified by:

getSearchResultModeValue in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The enum numeric value on the wire for searchResultMode.

setSearchResultModeValue

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setSearchResultModeValue(int value)

 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;

Parameters:

value - The enum numeric value on the wire for searchResultMode to set.

Returns:

This builder for chaining.

getSearchResultMode

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

Specified by:

getSearchResultMode in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The searchResultMode.

setSearchResultMode

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setSearchResultMode(SearchRequest.ContentSearchSpec.SearchResultMode value)

 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;

Parameters:

value - The searchResultMode to set.

Returns:

This builder for chaining.

clearSearchResultMode

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearSearchResultMode()

 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:

This builder for chaining.

hasCustomFineTuningSpec

public boolean hasCustomFineTuningSpec()

 Custom fine tuning configs.
 

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

Specified by:

hasCustomFineTuningSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

Whether the customFineTuningSpec field is set.

getCustomFineTuningSpec

public CustomFineTuningSpec getCustomFineTuningSpec()

 Custom fine tuning configs.
 

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

Specified by:

getCustomFineTuningSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Returns:

The customFineTuningSpec.

setCustomFineTuningSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setCustomFineTuningSpec(CustomFineTuningSpec value)

 Custom fine tuning configs.
 

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

setCustomFineTuningSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setCustomFineTuningSpec(CustomFineTuningSpec.Builder builderForValue)

 Custom fine tuning configs.
 

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

mergeCustomFineTuningSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeCustomFineTuningSpec(CustomFineTuningSpec value)

 Custom fine tuning configs.
 

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

clearCustomFineTuningSpec

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearCustomFineTuningSpec()

 Custom fine tuning configs.
 

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

getCustomFineTuningSpecBuilder

public CustomFineTuningSpec.Builder getCustomFineTuningSpecBuilder()

 Custom fine tuning configs.
 

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

getCustomFineTuningSpecOrBuilder

public CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()

 Custom fine tuning configs.
 

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

Specified by:

getCustomFineTuningSpecOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

getDataStoreSpecsList

public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

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

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

Specified by:

getDataStoreSpecsList in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

getDataStoreSpecsCount

public int getDataStoreSpecsCount()

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

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

Specified by:

getDataStoreSpecsCount in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

getDataStoreSpecs

public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

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

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

Specified by:

getDataStoreSpecs in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

setDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setDataStoreSpecs(int index,
                                                                            SearchRequest.DataStoreSpec value)

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

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

setDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder setDataStoreSpecs(int index,
                                                                            SearchRequest.DataStoreSpec.Builder builderForValue)

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

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

addDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)

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

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

addDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addDataStoreSpecs(int index,
                                                                            SearchRequest.DataStoreSpec value)

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

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

addDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)

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

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

addDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addDataStoreSpecs(int index,
                                                                            SearchRequest.DataStoreSpec.Builder builderForValue)

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

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

addAllDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)

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

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

clearDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder clearDataStoreSpecs()

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

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

removeDataStoreSpecs

public AnswerQueryRequest.SearchSpec.SearchParams.Builder removeDataStoreSpecs(int index)

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

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

getDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)

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

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

getDataStoreSpecsOrBuilder

public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

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

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

Specified by:

getDataStoreSpecsOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

getDataStoreSpecsOrBuilderList

public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

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

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

Specified by:

getDataStoreSpecsOrBuilderList in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

addDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()

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

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

addDataStoreSpecsBuilder

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)

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

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

getDataStoreSpecsBuilderList

public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()

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

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

setUnknownFields

public final AnswerQueryRequest.SearchSpec.SearchParams.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>

mergeUnknownFields

public final AnswerQueryRequest.SearchSpec.SearchParams.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AnswerQueryRequest.SearchSpec.SearchParams.Builder>