Member Junction
    Preparing search index...

    Class VectorizeEntityAction

    Action that vectorizes entities by creating and storing vector embeddings for entity documents. This action processes one or more entities and their associated documents to generate searchable vector representations for AI-powered semantic search and retrieval.

    // Vectorize a single entity
    await runAction({
      ActionName: 'Vectorize Entity',
      Params: [{
        Name: 'EntityNames',
        Value: 'Customers'
      }]
    });

    // Vectorize multiple entities
    await runAction({
      ActionName: 'Vectorize Entity',
      Params: [{
        Name: 'EntityNames',
        Value: ['Customers', 'Orders', 'Products']
      }]
    });

    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

    • Executes the vectorization process for specified entities.

      Parameters

      • params: RunActionParams

        The action parameters containing:

        • EntityNames: A string, comma-separated string, or array of entity names to vectorize
        • ContextUser: The user context for permissions and logging

      Returns Promise<ActionResultSimple>

      A promise resolving to an ActionResultSimple with:

      • Success: true if all matched documents were vectorized (or there were none to do)
      • Message: Combined messages from all vectorization operations
      • ResultCode:
        • "SUCCESS" if every matched Entity Document vectorized
        • "NO_DOCUMENTS" (Success: true) when no Active documents of the requested type exist — a benign no-op so unattended jobs (the daily Entity Vector Sync) don't report a failed run on a fresh/empty DB
        • "FAILED" if any document failed, or Config()/lookup threw

      Never throws - all errors (per-document and top-level) are caught and returned as a FAILED result.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods