SearchParams(mapping=None, *, ignore_unknown_fields=False, **kwargs)Search parameters.
Attributes |
|
|---|---|
| Name | Description |
max_return_results |
int
Number of search results to return. The default value is 10. |
filter |
str
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 __
|
boost_spec |
google.cloud.discoveryengine_v1.types.SearchRequest.BoostSpec
Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting __
|
order_by |
str
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.
|
search_result_mode |
google.cloud.discoveryengine_v1.types.SearchRequest.ContentSearchSpec.SearchResultMode
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 |
data_store_specs |
MutableSequence[google.cloud.discoveryengine_v1.types.SearchRequest.DataStoreSpec]
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. |