langchain.js
    Preparing search index...

    Interface SearchOptions

    interface SearchOptions {
        filter?: Record<
            string,
            null
            | string
            | number
            | boolean
            | FilterOperators,
        >;
        limit?: number;
        offset?: number;
        query?: string;
        refreshTtl?: boolean;
    }
    Index

    Properties

    filter? limit? offset? query? refreshTtl?

    Properties

    filter?: Record<string, null | string | number | boolean | FilterOperators>

    Filter conditions with support for advanced operators.

    limit?: number

    Maximum number of results to return.

    10
    offset?: number

    Number of results to skip for pagination.

    0
    query?: string

    Natural language search query.

    refreshTtl?: boolean

    Whether to refresh TTL for returned items.

    Settings

    Member Visibility

    On This Page

    Properties