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

    Methods

    InternalRunAction Run

    Constructors

    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
    Methods