@memberjunction/ai-vector-sync 1.8.1 → 2.1.0

package/dist/index.d.ts

@@ -1,5 +1,719 @@
-export * from './generic/vectorSync.types';
-export * from './generic/entitySyncConfig.types';
-export * from './models/entityVectorSync';
-export * from './generic/EntityDocumentTemplateParser';
-//# sourceMappingURL=index.d.ts.map
+import { Embeddings, EmbedTextsResult } from '@memberjunction/ai';
+import { VectorDBBase } from '@memberjunction/ai-vectordb';
+import { BaseEntity, RunViewParams, UserInfo, EntityField, EntityInfo } from '@memberjunction/core';
+import { TemplateEntityExtended } from '@memberjunction/templates-base-types';
+import { VectorBase } from '@memberjunction/ai-vectors';
+
+/**
+ * AI Models - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: AIModel
+ * * Base View: vwAIModels
+ * * @description Catalog of all AI Models configured in the system.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+declare class AIModelEntity extends BaseEntity {
+    /**
+    * Loads the AI Models record from the database
+    * @param ID: string - primary key value to load the AI Models record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof AIModelEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(50)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: Vendor
+    * * Display Name: Vendor
+    * * SQL Data Type: nvarchar(50)
+    */
+    get Vendor(): string | null;
+    set Vendor(value: string | null);
+    /**
+    * * Field Name: AIModelTypeID
+    * * Display Name: AI Model Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Model Types (vwAIModelTypes.ID)
+    */
+    get AIModelTypeID(): string;
+    set AIModelTypeID(value: string);
+    /**
+    * * Field Name: PowerRank
+    * * Display Name: Power Rank
+    * * SQL Data Type: int
+    * * Description: A simplified power rank of each model for a given AI Model Type. For example, if we have GPT 3, GPT 3.5, and GPT 4, we would have a PowerRank of 1 for GPT3, 2 for GPT 3.5, and 3 for GPT 4. This can be used within model families like OpenAI or across all models. For example if you had Llama 2 in the mix which is similar to GPT 3.5 it would also have a PowerRank of 2. This can be used at runtime to pick the most/least powerful or compare model relative power.
+    */
+    get PowerRank(): number | null;
+    set PowerRank(value: number | null);
+    /**
+    * * Field Name: IsActive
+    * * Display Name: Is Active
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    */
+    get IsActive(): boolean;
+    set IsActive(value: boolean);
+    /**
+    * * Field Name: DriverClass
+    * * Display Name: Driver Class
+    * * SQL Data Type: nvarchar(100)
+    */
+    get DriverClass(): string | null;
+    set DriverClass(value: string | null);
+    /**
+    * * Field Name: DriverImportPath
+    * * Display Name: Driver Import Path
+    * * SQL Data Type: nvarchar(255)
+    */
+    get DriverImportPath(): string | null;
+    set DriverImportPath(value: string | null);
+    /**
+    * * Field Name: APIName
+    * * Display Name: APIName
+    * * SQL Data Type: nvarchar(100)
+    * * Description: The name of the model to use with API calls which might differ from the Name, if APIName is not provided, Name will be used for API calls
+    */
+    get APIName(): string | null;
+    set APIName(value: string | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: AIModelType
+    * * Display Name: AIModel Type
+    * * SQL Data Type: nvarchar(50)
+    */
+    get AIModelType(): string;
+}
+/**
+ * Entity Documents - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: EntityDocument
+ * * Base View: vwEntityDocuments
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+declare class EntityDocumentEntity extends BaseEntity {
+    /**
+    * Loads the Entity Documents record from the database
+    * @param ID: string - primary key value to load the Entity Documents record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityDocumentEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Documents - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof EntityDocumentEntity
+    * @throws {Error} - Delete is not allowed for Entity Documents, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(250)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: TypeID
+    * * Display Name: Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Entity Document Types (vwEntityDocumentTypes.ID)
+    */
+    get TypeID(): string;
+    set TypeID(value: string);
+    /**
+    * * Field Name: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
+    */
+    get EntityID(): string;
+    set EntityID(value: string);
+    /**
+    * * Field Name: VectorDatabaseID
+    * * Display Name: Vector Database ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Vector Databases (vwVectorDatabases.ID)
+    */
+    get VectorDatabaseID(): string;
+    set VectorDatabaseID(value: string);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(15)
+    * * Default Value: Active
+    * * Value List Type: List
+    * * Possible Values
+    *   * Active
+    *   * Inactive
+    */
+    get Status(): 'Active' | 'Inactive';
+    set Status(value: 'Active' | 'Inactive');
+    /**
+    * * Field Name: TemplateID
+    * * Display Name: Template ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Templates (vwTemplates.ID)
+    */
+    get TemplateID(): string;
+    set TemplateID(value: string);
+    /**
+    * * Field Name: AIModelID
+    * * Display Name: AIModel ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Models (vwAIModels.ID)
+    */
+    get AIModelID(): string;
+    set AIModelID(value: string);
+    /**
+    * * Field Name: PotentialMatchThreshold
+    * * Display Name: Potential Match Threshold
+    * * SQL Data Type: numeric(12, 11)
+    * * Default Value: 1
+    * * Description: Value between 0 and 1 that determines what is considered a potential matching record. Value must be <= AbsoluteMatchThreshold. This is primarily used for duplicate detection but can be used for other applications as well where matching is relevant.
+    */
+    get PotentialMatchThreshold(): number;
+    set PotentialMatchThreshold(value: number);
+    /**
+    * * Field Name: AbsoluteMatchThreshold
+    * * Display Name: Absolute Match Threshold
+    * * SQL Data Type: numeric(12, 11)
+    * * Default Value: 1
+    * * Description: Value between 0 and 1 that determines what is considered an absolute matching record. Value must be >= PotentialMatchThreshold. This is primarily used for duplicate detection but can be used for other applications as well where matching is relevant.
+    */
+    get AbsoluteMatchThreshold(): number;
+    set AbsoluteMatchThreshold(value: number);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: __mj _Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: __mj _Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Type(): string;
+    /**
+    * * Field Name: Entity
+    * * Display Name: Entity
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Entity(): string;
+    /**
+    * * Field Name: VectorDatabase
+    * * Display Name: Vector Database
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get VectorDatabase(): string;
+    /**
+    * * Field Name: Template
+    * * Display Name: Template
+    * * SQL Data Type: nvarchar(255)
+    * * Default Value: null
+    */
+    get Template(): string;
+    /**
+    * * Field Name: AIModel
+    * * Display Name: AIModel
+    * * SQL Data Type: nvarchar(50)
+    * * Default Value: null
+    */
+    get AIModel(): string;
+}
+/**
+ * Template Contents - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: TemplateContent
+ * * Base View: vwTemplateContents
+ * * @description Template content for different versions of a template for purposes like HTML/Text/etc
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+declare class TemplateContentEntity extends BaseEntity {
+    /**
+    * Loads the Template Contents record from the database
+    * @param ID: string - primary key value to load the Template Contents record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof TemplateContentEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Template Contents - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof TemplateContentEntity
+    * @throws {Error} - Delete is not allowed for Template Contents, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: TemplateID
+    * * Display Name: Template ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Templates (vwTemplates.ID)
+    */
+    get TemplateID(): string;
+    set TemplateID(value: string);
+    /**
+    * * Field Name: TypeID
+    * * Display Name: Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Template Content Types (vwTemplateContentTypes.ID)
+    */
+    get TypeID(): string;
+    set TypeID(value: string);
+    /**
+    * * Field Name: TemplateText
+    * * Display Name: Template Text
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: The actual text content for the template
+    */
+    get TemplateText(): string | null;
+    set TemplateText(value: string | null);
+    /**
+    * * Field Name: Priority
+    * * Display Name: Priority
+    * * SQL Data Type: int
+    * * Description: Priority of the content version, higher priority versions will be used ahead of lower priority versions for a given Type
+    */
+    get Priority(): number;
+    set Priority(value: number);
+    /**
+    * * Field Name: IsActive
+    * * Display Name: Is Active
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: Indicates whether the content is active or not. Use this to disable a particular Template Content item without having to remove it
+    */
+    get IsActive(): boolean;
+    set IsActive(value: boolean);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Template
+    * * Display Name: Template
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Template(): string;
+    /**
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Type(): string;
+}
+/**
+ * Templates - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: Template
+ * * Base View: vwTemplates
+ * * @description Templates are used for dynamic expansion of a static template with data from a given context. Templates can be used to create documents, messages and anything else that requires dynamic document creation merging together static text, data and lightweight logic
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+declare class TemplateEntity extends BaseEntity {
+    /**
+    * Loads the Templates record from the database
+    * @param ID: string - primary key value to load the Templates record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof TemplateEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Templates - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof TemplateEntity
+    * @throws {Error} - Delete is not allowed for Templates, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Name of the template
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Description of the template
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: CategoryID
+    * * Display Name: Category ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Template Categories (vwTemplateCategories.ID)
+    */
+    get CategoryID(): string | null;
+    set CategoryID(value: string | null);
+    /**
+    * * Field Name: UserPrompt
+    * * Display Name: User Prompt
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: This prompt will be used by the AI to generate template content as requested by the user.
+    */
+    get UserPrompt(): string | null;
+    set UserPrompt(value: string | null);
+    /**
+    * * Field Name: UserID
+    * * Display Name: User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    */
+    get UserID(): string;
+    set UserID(value: string);
+    /**
+    * * Field Name: ActiveAt
+    * * Display Name: Active At
+    * * SQL Data Type: datetime
+    * * Description: Optional, if provided, this template will not be available for use until the specified date. Requires IsActive to be set to 1
+    */
+    get ActiveAt(): Date | null;
+    set ActiveAt(value: Date | null);
+    /**
+    * * Field Name: DisabledAt
+    * * Display Name: Disabled At
+    * * SQL Data Type: datetime
+    * * Description: Optional, if provided, this template will not be available for use after the specified date. If IsActive=0, this has no effect.
+    */
+    get DisabledAt(): Date | null;
+    set DisabledAt(value: Date | null);
+    /**
+    * * Field Name: IsActive
+    * * Display Name: Is Active
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: If set to 0, the template will be disabled regardless of the values in ActiveAt/DisabledAt.
+    */
+    get IsActive(): boolean;
+    set IsActive(value: boolean);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Category
+    * * Display Name: Category
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Category(): string | null;
+    /**
+    * * Field Name: User
+    * * Display Name: User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get User(): string;
+}
+/**
+ * Vector Databases - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: VectorDatabase
+ * * Base View: vwVectorDatabases
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+declare class VectorDatabaseEntity extends BaseEntity {
+    /**
+    * Loads the Vector Databases record from the database
+    * @param ID: string - primary key value to load the Vector Databases record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof VectorDatabaseEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Vector Databases - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof VectorDatabaseEntity
+    * @throws {Error} - Delete is not allowed for Vector Databases, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: DefaultURL
+    * * Display Name: Default URL
+    * * SQL Data Type: nvarchar(255)
+    */
+    get DefaultURL(): string | null;
+    set DefaultURL(value: string | null);
+    /**
+    * * Field Name: ClassKey
+    * * Display Name: Class Key
+    * * SQL Data Type: nvarchar(100)
+    */
+    get ClassKey(): string | null;
+    set ClassKey(value: string | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+}
+
+type VectorizeEntityParams = {
+    entityID: string;
+    entityDocumentID?: string;
+    batchCount?: number;
+    options?: any;
+};
+type VectorizeEntityResponse = {
+    success: boolean;
+    status: string;
+    errorMessage: string;
+};
+type EmbeddingData = {
+    ID: number;
+    Vector: number[];
+    VectorID?: unknown;
+    EntityData: Record<string, any>;
+    __mj_recordID: unknown;
+    __mj_compositeKey?: unknown;
+    EntityDocument?: Record<string, unknown>;
+    TemplateContent?: string;
+    VectorIndexID?: unknown;
+};
+type VectorEmeddingData = {
+    embedding: Embeddings;
+    vectorDB: VectorDBBase;
+    vectorDBClassKey: string;
+    vectorDBAPIKey: string;
+    embeddingDriverClass: string;
+    embeddingAPIKey: string;
+};
+type AnnotateWorkerContext = {
+    executionId: number;
+    entity: BaseEntity;
+    entityDocument: Record<string, unknown>;
+    template: TemplateEntityExtended;
+    templateContent: TemplateContentEntity;
+    embeddingDriverClass: string;
+    embeddingAPIKey: string;
+    delayTimeMS: number;
+};
+type ArchiveWorkerContext = {
+    executionId: number;
+    entity: BaseEntity;
+    entityDocument: EntityDocumentEntity;
+    vectorDBClassKey: string;
+    vectorDBAPIKey: string;
+    templateContent: TemplateContentEntity;
+    embeddings: EmbedTextsResult;
+    delayTimeMS: number;
+};
+type TemplateParamData = {
+    ParamName: string;
+    Data: unknown[];
+};
+
+type EntitySyncConfig = {
+    EntityDocumentID: string;
+    Interval: number;
+    RunViewParams: RunViewParams;
+    IncludeInSync: boolean;
+    LastRunDate: string;
+    VectorIndexID: number;
+    VectorID: number;
+};
+
+declare class EntityVectorSyncer extends VectorBase {
+    _startTime: Date;
+    _endTime: Date;
+    constructor();
+    Config(forceRefresh: boolean, contextUser?: UserInfo): Promise<void>;
+    VectorizeEntity(params: VectorizeEntityParams, contextUser?: UserInfo): Promise<VectorizeEntityResponse>;
+    CreateDefaultEntityDocument(EntityID: string, VectorDatabase: VectorDatabaseEntity, AIModel: AIModelEntity): Promise<EntityDocumentEntity>;
+    protected GetVectorDatabaseAndEmbeddingClassByEntityDocumentID(entityDocumentID: string, createDocumentIfNotFound?: boolean): Promise<VectorEmeddingData>;
+    GetEntityDocument(EntityDocumentID: string): Promise<EntityDocumentEntity | null>;
+    GetEntityDocumentByName(EntityDocumentName: string, ContextUser?: UserInfo): Promise<EntityDocumentEntity | null>;
+    GetActiveEntityDocuments(entityNames?: string[]): Promise<EntityDocumentEntity[]>;
+    private GetOrCreateVectorIndex;
+    protected CreateTemplateForEntityDocument(entityDocument: EntityDocumentEntity): Promise<TemplateEntity>;
+    protected BuildTemplateContent(entityFields: EntityField[]): string;
+    protected GetEntityFieldsForSimilaritySearch(entityID: string): Promise<EntityField[]>;
+    protected GetTemplateData(entity: EntityInfo, record: unknown, template: TemplateEntityExtended, relatedData: TemplateParamData[]): Promise<{
+        [key: string]: any;
+    }>;
+    protected GetRelatedTemplateDataForBatch(entity: EntityInfo, records: unknown[], template: TemplateEntityExtended): Promise<TemplateParamData[]>;
+    protected UpsertEntityRecordDocumentRecords(embeddingData: EmbeddingData, contextUser: UserInfo): Promise<void>;
+    protected ValidateTemplateContextParamAlignment(template: TemplateEntityExtended): boolean;
+}
+
+declare abstract class EntityDocumentTemplateParserBase {
+    static ClearCache(): void;
+    static CreateCacheKey(EntityID: string, EntityRecordPrimaryKey: string, Content: string): string;
+    protected static __cache: {
+        [key: string]: string;
+    };
+    protected static get _cache(): {
+        [key: string]: string;
+    };
+    Parse(Template: string, EntityID: string, EntityRecord: any, ContextUser: UserInfo): Promise<string>;
+    protected evalSingleArgument(argument: string, entityID: string, entityRecord: any, ContextUser: UserInfo): Promise<string>;
+}
+
+declare class EntityDocumentTemplateParser extends EntityDocumentTemplateParserBase {
+    static CreateInstance(): EntityDocumentTemplateParser;
+    protected Relationship(entityID: string, entityRecord: any, ContextUser: UserInfo, relationshipName: string, maxRows: number, entityDocumentName: string): Promise<string>;
+}
+
+export { type AnnotateWorkerContext, type ArchiveWorkerContext, type EmbeddingData, EntityDocumentTemplateParser, type EntitySyncConfig, EntityVectorSyncer, type TemplateParamData, type VectorEmeddingData, type VectorizeEntityParams, type VectorizeEntityResponse };