public static final class AnswerQueryRequest.SearchSpec.SearchParams extends GeneratedMessageV3 implements AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder
Search parameters.
Protobuf type
google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchParams
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder()
newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype)
public static AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilder(AnswerQueryRequest.SearchSpec.SearchParams prototype)
public static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input)
public static AnswerQueryRequest.SearchSpec.SearchParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(CodedInputStream input)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest.SearchSpec.SearchParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AnswerQueryRequest.SearchSpec.SearchParams> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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.v1.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
.google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 3;
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.v1.SearchRequest.DataStoreSpec data_store_specs = 7;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.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.v1.SearchRequest.DataStoreSpec data_store_specs = 7;
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.v1.SearchRequest.DataStoreSpec data_store_specs = 7;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.SearchRequest.DataStoreSpec data_store_specs = 7;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpecOrBuilder> |
|
getDefaultInstanceForType()
public AnswerQueryRequest.SearchSpec.SearchParams getDefaultInstanceForType()
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()
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.v1.SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;
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.v1.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.v1.SearchRequest.BoostSpec boost_spec = 3;
| Returns |
| Type |
Description |
boolean |
Whether the boostSpec field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnswerQueryRequest.SearchSpec.SearchParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AnswerQueryRequest.SearchSpec.SearchParams.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
