Member Junction
    Preparing search index...

    Interface SearchClientParams

    Parameters for executing a search query.

    interface SearchClientParams {
        Filters?: SearchClientFilters;
        MaxResults?: number;
        MinScore?: number;
        Query: string;
        ScopeIDs?: string[];
        SearchContext?: {
            PrimaryScopeEntityID?: string;
            PrimaryScopeRecordID?: string;
            SecondaryScopes?: Record<string, unknown>;
        };
    }
    Index

    Properties

    Filters? MaxResults? MinScore? Query ScopeIDs? SearchContext?

    Properties

    Filters?: SearchClientFilters

    Optional filters to narrow search results

    MaxResults?: number

    Maximum number of results to return

    MinScore?: number

    Minimum relevance score threshold (0-1)

    Query: string

    The search query text

    ScopeIDs?: string[]

    Optional array of MJ: Search Scopes record IDs. When provided, the server resolves each scope's metadata (providers, external indexes, entities, storage accounts) and runs only those constrained providers. Results from multiple scopes are combined via cross-scope RRF fusion. Omit (or pass an empty array) for backward-compatible unscoped search.

    SearchContext?: {
        PrimaryScopeEntityID?: string;
        PrimaryScopeRecordID?: string;
        SecondaryScopes?: Record<string, unknown>;
    }

    Optional runtime multi-tenant context. Flows to every provider so one scope definition can serve many tenants.

    Settings

    Member Visibility

    On This Page

    Properties