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

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Accessors

    • get SupportsAudience(): boolean

      Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone besides the caller who will see its output, such as the other participants of a shared conversation.

      false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller, ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running it. Override to return true only when the action honours the audience in full — every record, snippet and count it returns is something every reader may see (pass the audience to the search engine, check each reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).

      Returns boolean

    Methods

    Settings

    Member Visibility

    On This Page

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