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.

Example

// 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 full)

Constructors

constructor

Methods

InternalRunAction Run

Constructors

constructor

Methods

Protected InternalRunAction

  • InternalRunAction(params): Promise<ActionResultSimple>

  • Executes the vectorization process for specified entities.

    Parameters

    • params: RunActionParams<any>

      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 entities were vectorized successfully
    • Message: Combined messages from all vectorization operations
    • ResultCode: "SUCCESS" if all succeeded, "FAILED" if any failed

    Throws

    Never throws directly - all errors are caught and returned in the result

Run

  • Run(params): Promise<ActionResultSimple>

  • Executes the action with the provided parameters.

    Parameters

    • params: RunActionParams<any>

      The action execution parameters including context

    Returns Promise<ActionResultSimple>

    Promise resolving to the action result

Settings

Member Visibility

Theme

On This Page

constructorInternalRunActionRun