| query |
String |
The search query string (max 10000 characters) |
|
| vector_options |
Option<Vec> |
List of vectors, fields, and weights to use for searching. If empty, equal weights will be auto-generated for all available vectors. |
[optional][default to []] |
| custom_vectors |
Option<Vec> |
Pre-generated custom vectors for this search query (optional) |
[optional] |
| limit |
Option<i32> |
Maximum number of results to return (1 to 100) |
[optional][default to 10] |
| score_threshold |
Option<f64> |
Optional minimum score threshold. Results below this score will be excluded |
[optional] |
| document_tags |
Option<Vec> |
Optional filter to include only documents with specific tags (max 50 tags, each max 100 characters; cannot contain pipe characters) |
[optional] |
| document_tags_match_all |
Option<bool> |
If True, documents must have ALL specified tags (AND). If False, documents must have ANY of the specified tags (OR). |
[optional][default to false] |
| metadata_filter |
Option<models::MetadataFilter> |
|
[optional] |
| join |
Option<models::Join> |
|
[optional] |
| exclude |
Option<Vec> |
Optional list of document fields to omit from search results (and from documents attached via 'joined'). Allowed values: name, description, content, tags, metadata. (enum: name, description, content, tags, metadata) |
[optional] |
| group_field |
Option<String> |
Optional indexed metadata field to group results by. When set, results are capped at group_max per distinct value of this field, refetching up to group_max_fetches times if needed to fill the requested limit. |
[optional] |
| group_max |
Option<i32> |
Maximum number of results allowed per group_field value |
[optional][default to 3] |
| group_max_fetches |
Option<i32> |
Total number of fetches (including the first) allowed while grouping |
[optional][default to 2] |
| facets |
Option<bool> |
If True, compute facet counts over the candidate pool for every field declared in the collection's metadata_indexes. Counts are returned in SearchResponse.facet_counts. |
[optional][default to false] |
| facet_options |
Option<models::FacetOptions> |
Tuning for faceting (prefetch window and max values per field). Used only when facets is True. |
[optional] |
| raw_scores |
Option<bool> |
Whether to include individual vector scores in results |
[optional][default to false] |
| fusion_mode |
Option<FusionMode> |
How to combine multi-vector search results. 'rrf' = reciprocal rank fusion (rank-based). 'linear' = min-max normalize each retriever's scores on its prefetch list, then sum weight * normalized score. (enum: rrf, linear) |
[optional][default to Rrf] |