- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static interface AnswerQueryRequest.SearchSpec.SearchParamsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBoostSpec()
public abstract 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 abstract 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 abstract CustomFineTuningSpec getCustomFineTuningSpec()Custom fine tuning configs.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;
| Returns | |
|---|---|
| Type | Description |
CustomFineTuningSpec |
The customFineTuningSpec. |
getCustomFineTuningSpecOrBuilder()
public abstract CustomFineTuningSpecOrBuilder getCustomFineTuningSpecOrBuilder()Custom fine tuning configs.
.google.cloud.discoveryengine.v1alpha.CustomFineTuningSpec custom_fine_tuning_spec = 6;
| Returns | |
|---|---|
| Type | Description |
CustomFineTuningSpecOrBuilder |
|
getDataStoreSpecs(int index)
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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> |
|
getFilter()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getSearchResultMode()
public abstract SearchRequest.ContentSearchSpec.SearchResultMode getSearchResultMode() Specifies the search result mode. If unspecified, the
search result mode 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 abstract int getSearchResultModeValue() Specifies the search result mode. If unspecified, the
search result mode 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. |
hasBoostSpec()
public abstract 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 abstract 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. |