Home > @findkit/ui > SearchParams
SearchParams interface
Same as FindkitSearchGroupParams but without "from" field since it is managed by the SearchEngine
Signature:
export interface SearchParams
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| content? | boolean | (Optional) EXPERIMENTAL Return the hit content as well |
|
| createdDecay? | number | (Optional) https://docs.findkit.com/ui/api/params#createdDecay | |
| decayScale? | string | (Optional) https://docs.findkit.com/ui/api/params#decayScale | |
| filter? | Filter | (Optional) New in v0.9.0 Filter search results with complex operators See Filter https://docs.findkit.com/ui/api/params#filter |
|
| highlightLength? | number | (Optional) https://docs.findkit.com/ui/api/params#highlightLength | |
| lang? | string | (Optional) https://docs.findkit.com/ui/api/params#lang | |
| modifiedDecay? | number | (Optional) https://docs.findkit.com/ui/api/params#modifiedDecay | |
| operator? | "and" | "or" | (Optional) https://docs.findkit.com/ui/api/params#operator | |
| randomSort? | RandomSort | (Optional) New in v.1.4.0 Return search results in random order See https://docs.findkit.com/ui/api/params#randomSort |
|
| semantic? | { mode: "only" | "hybrid" | "hybrid2"; weight?: number; k?: number; } | (Optional) Execute semantic search | |
| size? | number | (Optional) https://docs.findkit.com/ui/api/params#size | |
| skip? | boolean | (Optional) New in v0.15.0 https://docs.findkit.com/ui/api/params#skip |
|
| sort? | Sort | Sort[] | (Optional) New in v0.9.0 Sort search results See Sort https://docs.findkit.com/ui/api/params#sort |
|
| tagBoost? | { [tag: string]: number; } | (Optional) https://docs.findkit.com/ui/api/params#tagBoost | |
| tagQuery? | string[][] | (Optional) https://docs.findkit.com/ui/api/params#tagQuery |