Member Junction
    Preparing search index...

    Type Alias SearchEntitiesOptions

    Options for IMetadataProvider.SearchEntity / IMetadataProvider.SearchEntities.

    type SearchEntitiesOptions = {
        contextUser?: UserInfo;
        entityDocumentId?: string;
        minScore?: number;
        mode?: "lexical" | "semantic" | "hybrid";
        rrfK?: number;
        topK?: number;
        weights?: { lexical?: number; semantic?: number };
    }
    Index

    Properties

    contextUser? entityDocumentId? minScore? mode? rrfK? topK? weights?

    Properties

    contextUser?: UserInfo

    Context user for permission filtering and embedding-model lookup.

    entityDocumentId?: string

    Override which EntityDocument to use. Defaults to the active Search-category EntityDocument registered for the entity.

    minScore?: number

    Drop results below this final blended score. Default: 0.

    mode?: "lexical" | "semantic" | "hybrid"

    Ranking strategy:

    • 'lexical': name-field substring / prefix matching only.
    • 'semantic': vector cosine against the EntityDocument-backed index.
    • 'hybrid': weighted RRF blend of the two. Default.
    rrfK?: number

    RRF smoothing constant. Default: 60 (paper standard).

    topK?: number

    Maximum results to return after filtering. Default: 10.

    weights?: { lexical?: number; semantic?: number }

    Per-list weights for hybrid mode. Default: { lexical: 1.0, semantic: 1.0 }.

    Settings

    Member Visibility

    On This Page

    Properties