public static final class AnswerQueryRequest.SearchSpec.SearchParams extends com.google.protobuf.GeneratedMessageV3 implements AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder
Search parameters.Protobuf type
google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec.SearchParams| Modifier and Type | Class and Description |
|---|---|
static class |
AnswerQueryRequest.SearchSpec.SearchParams.Builder
Search parameters.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BOOST_SPEC_FIELD_NUMBER |
static int |
CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER |
static int |
DATA_STORE_SPECS_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
MAX_RETURN_RESULTS_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
SEARCH_RESULT_MODE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
static AnswerQueryRequest.SearchSpec.SearchParams |
getDefaultInstance() |
AnswerQueryRequest.SearchSpec.SearchParams |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<AnswerQueryRequest.SearchSpec.SearchParams> |
getParserForType() |
SearchRequest.ContentSearchSpec.SearchResultMode |
getSearchResultMode()
Specifies the search result mode.
|
int |
getSearchResultModeValue()
Specifies the search result mode.
|
int |
getSerializedSize() |
boolean |
hasBoostSpec()
Boost specification to boost certain documents in search results which
may affect the answer query response.
|
boolean |
hasCustomFineTuningSpec()
Custom fine tuning configs.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static AnswerQueryRequest.SearchSpec.SearchParams.Builder |
newBuilder() |
static AnswerQueryRequest.SearchSpec.SearchParams.Builder |
newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype) |
AnswerQueryRequest.SearchSpec.SearchParams.Builder |
newBuilderForType() |
protected AnswerQueryRequest.SearchSpec.SearchParams.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseDelimitedFrom(InputStream input) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(byte[] data) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(ByteBuffer data) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(com.google.protobuf.ByteString data) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(com.google.protobuf.CodedInputStream input) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(InputStream input) |
static AnswerQueryRequest.SearchSpec.SearchParams |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<AnswerQueryRequest.SearchSpec.SearchParams> |
parser() |
AnswerQueryRequest.SearchSpec.SearchParams.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int MAX_RETURN_RESULTS_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
public static final int SEARCH_RESULT_MODE_FIELD_NUMBER
public static final int CUSTOM_FINE_TUNING_SPEC_FIELD_NUMBER
public static final int DATA_STORE_SPECS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getMaxReturnResults()
Number of search results to return. The default value is 10.
int32 max_return_results = 1;getMaxReturnResults in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getFilter in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getFilterBytes in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;hasBoostSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getBoostSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getBoostSpecOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getOrderBy in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;getOrderByBytes in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getSearchResultModeValue in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getSearchResultMode in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic boolean hasCustomFineTuningSpec()
Custom fine tuning configs.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;
hasCustomFineTuningSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic CustomFineTuningSpec getCustomFineTuningSpec()
Custom fine tuning configs.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;
getCustomFineTuningSpec in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()
Custom fine tuning configs.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;
getCustomFineTuningSpecOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getDataStoreSpecsList in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getDataStoreSpecsOrBuilderList in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getDataStoreSpecsCount in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getDataStoreSpecs in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic 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;
getDataStoreSpecsOrBuilder in interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input) throws IOException
IOExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder()
public static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype)
public AnswerQueryRequest.SearchSpec.SearchParams.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstance()
public static com.google.protobuf.Parser<AnswerQueryRequest.SearchSpec.SearchParams> parser()
public com.google.protobuf.Parser<AnswerQueryRequest.SearchSpec.SearchParams> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.