Unispec Docs
SDK ReferenceInterfaces

QueryOptions

Interface: QueryOptions

Defined in: packages/sdk/src/backend/indexes.ts:53

Properties

filter?

optional filter?: MetadataFilter

Defined in: packages/sdk/src/backend/indexes.ts:61


id?

optional id?: string

Defined in: packages/sdk/src/backend/indexes.ts:55


includeMetadata?

optional includeMetadata?: boolean

Defined in: packages/sdk/src/backend/indexes.ts:64


includeValues?

optional includeValues?: boolean

Defined in: packages/sdk/src/backend/indexes.ts:63


mode?

optional mode?: QueryMode

Defined in: packages/sdk/src/backend/indexes.ts:59

dense | sparse | hybrid. Defaults to hybrid on hybrid indexes when text is given (fused score = RRF, not cosine), dense otherwise.


namespace?

optional namespace?: string

Defined in: packages/sdk/src/backend/indexes.ts:62


text?

optional text?: string

Defined in: packages/sdk/src/backend/indexes.ts:56


topK?

optional topK?: number

Defined in: packages/sdk/src/backend/indexes.ts:60


vector?

optional vector?: number[]

Defined in: packages/sdk/src/backend/indexes.ts:54

On this page