Skip to content

Interface: SearchOptions

Options accepted by a single-index search.

optional columns?: readonly string[]

Columns to return per hit. Defaults to the index’s configured columns.


optional filter?: Record<string, string | number | boolean | (string | number)[]>

AppKit AI Search scalar/array filters.


optional limit?: number

Maximum hits to return. Defaults to the configured page size.


optional mode?: "hybrid" | "vector" | "keyword"

Match mode. Defaults to the configured mode (hybrid).


optional scoreThreshold?: number

Drop hits below this score.


optional signal?: AbortSignal

External cancellation.