Member Junction
    Preparing search index...

    Class SearchEntityAction

    Action wrapper around Metadata.Provider.SearchEntity: ranked hybrid (lexical + semantic) search over one entity's records, with permission filtering. The classic agent prompt-seeding case — swap a 1500-row entity dump for "here are 10 likely candidates" — is just SearchEntity({ entityName: 'MJ: Entities', searchText: userText, options: { topK: 10 } }).

    • Search Entity (this action): "Find me the N most relevant records of one entity for this free-text request." Hybrid lexical + semantic ranking, backed by an EntityDocument of type Search. Use for agent prompt seeding, in-app "find a customer/invoice/document" UX.
    • Get Entity Details / Get Entity List: deterministic metadata or row reads, no ranking. Use when you already know which entity / which records.
    • Search Query Catalog / unified Search actions (@memberjunction/ai-search): cross-source search across vectors, full-text, entities, storage — broader in scope, slower, requires SearchScope configuration. Use when the agent doesn't know which entity to look in.

    Returns a JSON payload of { count, results: EntitySearchResult[] } in the action Message, plus Count and Results output params.

    await runAction({
      ActionName: 'Search Entity',
      Params: [
        { Name: 'EntityName', Value: 'MJ: Entities' },
        { Name: 'SearchText', Value: 'invoices' },
        { Name: 'TopK', Value: 10 },
        { Name: 'Mode', Value: 'hybrid' }
      ]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    InternalRunAction Run

    Constructors

    Methods

    Settings

    Member Visibility

    On This Page

    When to use this Action vs. the others MJ already exposes
    Constructors
    Methods