Type Alias DocumentsQuery<T>

DocumentsQuery: ResourceQuery & {
    fields?: Fields<T>;
    filter?: Filter;
    ids?: string[] | number[];
    limit?: number;
    offset?: number;
    retrieveVectors?: boolean;
    sort?: string[];
}

Type Parameters

T = RecordAny

Type Declaration

Optionalfields?: Fields<T>
Optionalfilter?: Filter
Optionalids?: string[] | number[]
Optionallimit?: number
Optionaloffset?: number
OptionalretrieveVectors?: boolean
Optionalsort?: string[]
Array of strings containing the attributes to sort on. Each string should be in the format "attribute:direction" where direction is either "asc" or "desc". Example: ["price:asc", "rating:desc"]

Type Alias DocumentsQuery<T>

Type Parameters

Type Declaration

`Optional`fields?: Fields<T>

`Optional`filter?: Filter

`Optional`ids?: string[] | number[]

`Optional`limit?: number

`Optional`offset?: number

`Optional`retrieveVectors?: boolean

`Optional`sort?: string[]

Settings

Type Alias DocumentsQuery<T>

Type Parameters

Type Declaration

Optionalfields?: Fields<T>

Optionalfilter?: Filter

Optionalids?: string[] | number[]

Optionallimit?: number

Optionaloffset?: number

OptionalretrieveVectors?: boolean

Optionalsort?: string[]

Settings

`Optional`fields?: Fields<T>

`Optional`filter?: Filter

`Optional`ids?: string[] | number[]

`Optional`limit?: number

`Optional`offset?: number

`Optional`retrieveVectors?: boolean

`Optional`sort?: string[]