Class AnswerQueryRequest.SearchSpec.SearchParams (0.42.0)

public static final class AnswerQueryRequest.SearchSpec.SearchParams extends GeneratedMessageV3 implements AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder

Search parameters.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnswerQueryRequest.SearchSpec.SearchParams

Static Fields

BOOST_SPEC_FIELD_NUMBER

public static final int BOOST_SPEC_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER

public static final int CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER
Field Value
Type Description
int

DATA_STORE_SPECS_FIELD_NUMBER

public static final int DATA_STORE_SPECS_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

MAX_RETURN_RESULTS_FIELD_NUMBER

public static final int MAX_RETURN_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_RESULT_MODE_FIELD_NUMBER

public static final int SEARCH_RESULT_MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstance()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder

newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype)

public static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype)
Parameter
Name Description
prototype AnswerQueryRequest.SearchSpec.SearchParams
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder

parseDelimitedFrom(InputStream input)

public static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnswerQueryRequest.SearchSpec.SearchParams> parser()
Returns
Type Description
Parser<SearchParams>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

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

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

Returns
Type Description
SearchRequest.BoostSpecOrBuilder

getCustomFineTuningSpec()

public CustomFineTuningSpec getCustomFineTuningSpec()

Custom fine tuning configs.

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

Returns
Type Description
CustomFineTuningSpec

The customFineTuningSpec.

getCustomFineTuningSpecOrBuilder()

public CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()

Custom fine tuning configs.

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

Returns
Type Description
CustomFineTuningSpecOrBuilder

getDataStoreSpecs(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec

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;

Returns
Type Description
int

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;

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpecOrBuilder

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;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1alpha.SearchRequest.DataStoreSpecOrBuilder>

getDefaultInstanceForType()

public AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstanceForType()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams

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

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public 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

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getMaxReturnResults()

public int getMaxReturnResults()

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

int32 max_return_results = 1;

Returns
Type Description
int

The maxReturnResults.

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 4;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

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

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

string order_by = 4;

Returns
Type Description
ByteString

The bytes for orderBy.

getParserForType()

public Parser<AnswerQueryRequest.SearchSpec.SearchParams> getParserForType()
Returns
Type Description
Parser<SearchParams>
Overrides

getSearchResultMode()

public SearchRequest.ContentSearchSpec.SearchResultMode getSearchResultMode()

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS. See parse and chunk documents

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

Returns
Type Description
SearchRequest.ContentSearchSpec.SearchResultMode

The searchResultMode.

getSearchResultModeValue()

public int getSearchResultModeValue()

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS. See parse and chunk documents

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

Returns
Type Description
int

The enum numeric value on the wire for searchResultMode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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

Returns
Type Description
boolean

Whether the boostSpec field is set.

hasCustomFineTuningSpec()

public boolean hasCustomFineTuningSpec()

Custom fine tuning configs.

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

Returns
Type Description
boolean

Whether the customFineTuningSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnswerQueryRequest.SearchSpec.SearchParams.Builder toBuilder()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException