@memberjunction/ai 3.4.0 → 4.1.0

package/dist/generic/baseModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseModel.d.ts","sourceRoot":"","sources":["../../src/generic/baseModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,qBAAa,UAAU;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;IACf,OAAO,EAAE,IAAI,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,GAAG,CAAA;IAId,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB,IAAI,WAAW,IAAI,MAAM,CAExB;gBACY,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI;CAKhE;AAED,qBAAa,UAAU;IAInB,KAAK,EAAE,MAAM,CAAA;IAKb,WAAW,CAAC,EAAE,MAAM,CAAA;IAKpB,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,eAAe,CAAS;IAKhF,2BAA2B,CAAC,EAAE,GAAG,CAAA;IAKjC,eAAe,CAAC,EAAE,MAAM,CAAA;IAKxB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAO9B,IAAI,CAAC,EAAE,MAAM,CAAA;IAMb,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAYD,qBAAa,UAAU;gBASP,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAgBhG,YAAY,EAAE,MAAM,CAAA;IAMpB,gBAAgB,EAAE,MAAM,CAAA;IAOxB,IAAI,CAAC,EAAE,MAAM,CAAA;IAOb,YAAY,CAAC,EAAE,MAAM,CAAA;IAMrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAMlB,UAAU,CAAC,EAAE,MAAM,CAAA;IAMnB,cAAc,CAAC,EAAE,MAAM,CAAA;IAQvB,IAAI,WAAW,IAAI,MAAM,CAExB;CACJ;AAKD,8BAAsB,SAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IAIxB,SAAS,KAAK,MAAM,IAAI,MAAM,CAE7B;gBACY,MAAM,EAAE,MAAM;CAM9B"}
+{"version":3,"file":"baseModel.d.ts","sourceRoot":"","sources":["../../src/generic/baseModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,qBAAa,UAAU;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;IACf,OAAO,EAAE,IAAI,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,GAAG,CAAA;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB,IAAI,WAAW,IAAI,MAAM,CAExB;gBACY,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI;CAKhE;AAED,qBAAa,UAAU;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,eAAe,CAAS;IAEhF;;OAEG;IACH,2BAA2B,CAAC,EAAE,GAAG,CAAA;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CAC3B;AAED;;;;;;;;;GASG;AACH,qBAAa,UAAU;IACnB;;;;;;;OAOG;gBACS,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAWhG;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;OAKG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;CACJ;AAED;;GAEG;AACH,8BAAsB,SAAS;IAC3B,OAAO,CAAC,OAAO,CAAS;IACxB;;OAEG;IACH,SAAS,KAAK,MAAM,IAAI,MAAM,CAE7B;gBACY,MAAM,EAAE,MAAM;CAM9B"}

package/dist/generic/baseModel.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseModel = exports.ModelUsage = exports.BaseParams = exports.BaseResult = void 0;
-class BaseResult {
+export class BaseResult {
     get timeElapsed() {
         return this.endTime.getTime() - this.startTime.getTime();
     }
@@ -11,14 +8,33 @@ class BaseResult {
         this.endTime = endTime;
     }
 }
-exports.BaseResult = BaseResult;
-class BaseParams {
+export class BaseParams {
     constructor() {
+        /**
+         * Specifies the format that the model should output. Not all models support all formats. If not specified, the default is 'Any'.
+         */
         this.responseFormat = 'Any';
     }
 }
-exports.BaseParams = BaseParams;
-class ModelUsage {
+/**
+ * Represents token usage and cost information for an AI model execution.
+ *
+ * This class tracks the number of tokens used in both the prompt (input) and
+ * completion (output) phases of an AI model execution, along with optional
+ * cost information when provided by the AI provider.
+ *
+ * @class ModelUsage
+ * @since 2.43.0
+ */
+export class ModelUsage {
+    /**
+     * Creates a new ModelUsage instance.
+     *
+     * @param {number} promptTokens - Number of tokens used in the prompt/input
+     * @param {number} completionTokens - Number of tokens generated in the completion/output
+     * @param {number} [cost] - Optional cost of the execution
+     * @param {string} [costCurrency] - Optional currency code for the cost (e.g., 'USD', 'EUR', 'GBP')
+     */
     constructor(promptTokens, completionTokens, cost, costCurrency) {
         this.promptTokens = promptTokens;
         this.completionTokens = completionTokens;
@@ -29,12 +45,23 @@ class ModelUsage {
             this.costCurrency = costCurrency;
         }
     }
+    /**
+     * Calculated total number of tokens (prompt + completion).
+     * This is useful for tracking overall token usage against limits.
+     *
+     * @returns {number} The sum of promptTokens and completionTokens
+     */
     get totalTokens() {
         return this.promptTokens + this.completionTokens;
     }
 }
-exports.ModelUsage = ModelUsage;
-class BaseModel {
+/**
+ * Base AI model class, used for everything else in the MemberJunction AI environment
+ */
+export class BaseModel {
+    /**
+     * Only sub-classes can access the API key
+     */
     get apiKey() {
         return this._apiKey;
     }
@@ -44,5 +71,4 @@ class BaseModel {
         this._apiKey = apiKey;
     }
 }
-exports.BaseModel = BaseModel;
 //# sourceMappingURL=baseModel.js.map

package/dist/generic/baseModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseModel.js","sourceRoot":"","sources":["../../src/generic/baseModel.ts"],"names":[],"mappings":";;;AAEA,MAAa,UAAU;IAUnB,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7D,CAAC;IACD,YAAa,OAAgB,EAAE,SAAe,EAAE,OAAa;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AAlBD,gCAkBC;AAED,MAAa,UAAU;IAAvB;QAcI,mBAAc,GAA4D,KAAK,CAAC;IA6BpF,CAAC;CAAA;AA3CD,gCA2CC;AAYD,MAAa,UAAU;IASnB,YAAY,YAAoB,EAAE,gBAAwB,EAAE,IAAa,EAAE,YAAqB;QAC5F,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACrC,CAAC;IACL,CAAC;IAqDD,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC;IACrD,CAAC;CACJ;AA1ED,gCA0EC;AAKD,MAAsB,SAAS;IAK3B,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,YAAa,MAAc;QACvB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;QAE9F,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;CACJ;AAdD,8BAcC"}
+{"version":3,"file":"baseModel.js","sourceRoot":"","sources":["../../src/generic/baseModel.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,UAAU;IAUnB,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IAC7D,CAAC;IACD,YAAa,OAAgB,EAAE,SAAe,EAAE,OAAa;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AAED,MAAM,OAAO,UAAU;IAAvB;QAWI;;WAEG;QACH,mBAAc,GAA4D,KAAK,CAAC;IA6BpF,CAAC;CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAU;IACnB;;;;;;;OAOG;IACH,YAAY,YAAoB,EAAE,gBAAwB,EAAE,IAAa,EAAE,YAAqB;QAC5F,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACrC,CAAC;IACL,CAAC;IA+CD;;;;;OAKG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC;IACrD,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAgB,SAAS;IAE3B;;OAEG;IACH,IAAc,MAAM;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IACD,YAAa,MAAc;QACvB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;QAE9F,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;CACJ"}

package/dist/generic/baseReranker.d.ts

@@ -1,13 +1,92 @@
-import { BaseModel } from './baseModel';
-import { RerankParams, RerankResponse, RerankResult } from './reranker.types';
+/**
+ * @fileoverview Abstract base class for AI reranker implementations.
+ *
+ * Provides the foundation for semantic reranking providers (Cohere, LLM-based, etc.)
+ * following the same patterns as BaseLLM and BaseEmbeddings.
+ *
+ * Implementations should:
+ * 1. Register with @RegisterClass(BaseReranker, 'ProviderName')
+ * 2. Implement the protected doRerank() method
+ * 3. Handle provider-specific API calls and response mapping
+ *
+ * @module @memberjunction/ai
+ * @since 3.0.0
+ */
+import { BaseModel } from './baseModel.js';
+import { RerankParams, RerankResponse, RerankResult } from './reranker.types.js';
+/**
+ * Abstract base class for all reranker implementations.
+ * Extends BaseModel to follow MJ conventions for AI model classes.
+ *
+ * Provides common functionality including:
+ * - Input validation
+ * - Response standardization
+ * - Utility methods for sorting and filtering results
+ *
+ * Example usage:
+ * ```typescript
+ * @RegisterClass(BaseReranker, 'CohereReranker')
+ * export class CohereReranker extends BaseReranker {
+ *     protected async doRerank(params: RerankParams): Promise<RerankResult[]> {
+ *         // Call Cohere API and return results
+ *     }
+ * }
+ * ```
+ */
 export declare abstract class BaseReranker extends BaseModel {
     protected _modelName: string;
+    /**
+     * Create a new reranker instance.
+     * @param apiKey - API key for the reranking service (e.g., Cohere API key)
+     * @param modelName - Optional model name to use (provider-specific)
+     */
     constructor(apiKey: string, modelName?: string);
+    /**
+     * Get the model name used for this reranker
+     */
     get ModelName(): string;
+    /**
+     * Rerank documents based on their relevance to a query.
+     * This is the main entry point for reranking operations.
+     *
+     * The method:
+     * 1. Validates input parameters
+     * 2. Calls the provider-specific doRerank() implementation
+     * 3. Applies topK limit if specified
+     * 4. Returns standardized RerankResponse
+     *
+     * @param params - Reranking parameters including query and documents
+     * @returns Promise resolving to RerankResponse with reranked results
+     */
     Rerank(params: RerankParams): Promise<RerankResponse>;
+    /**
+     * Provider-specific reranking implementation.
+     * Subclasses must implement this method to perform the actual reranking.
+     *
+     * Implementation requirements:
+     * - Call the provider's reranking API
+     * - Map results to RerankResult format
+     * - Sort results by relevance score (highest first)
+     * - Preserve document metadata for zero-copy retrieval
+     *
+     * @param params - Reranking parameters
+     * @returns Promise resolving to array of RerankResult sorted by relevance
+     */
     protected abstract doRerank(params: RerankParams): Promise<RerankResult[]>;
+    /**
+     * Create a standardized error response.
+     * Used internally when validation fails or an exception occurs.
+     */
     protected createErrorResponse(message: string, startTime: number): RerankResponse;
+    /**
+     * Sort results by relevance score in descending order.
+     * Utility method for implementations.
+     */
     protected sortByRelevance(results: RerankResult[]): RerankResult[];
+    /**
+     * Filter results by minimum relevance threshold.
+     * Utility method for implementations that need to filter low-scoring results.
+     */
     protected filterByThreshold(results: RerankResult[], minScore: number): RerankResult[];
 }
 //# sourceMappingURL=baseReranker.d.ts.map

package/dist/generic/baseReranker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseReranker.d.ts","sourceRoot":"","sources":["../../src/generic/baseReranker.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAqB9E,8BAAsB,YAAa,SAAQ,SAAS;IAChD,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;gBAOjB,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAQ9C,IAAW,SAAS,IAAI,MAAM,CAE7B;IAeY,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAoElE,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAM1E,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc;IAcjF,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE;IAQlE,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,YAAY,EAAE;CAGzF"}
+{"version":3,"file":"baseReranker.d.ts","sourceRoot":"","sources":["../../src/generic/baseReranker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAE9E;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,YAAa,SAAQ,SAAS;IAChD,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAK9C;;OAEG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;;;;;;;;;;;OAYG;IACU,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAuDlE;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAE1E;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,cAAc;IAUjF;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE;IAIlE;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,YAAY,EAAE;CAGzF"}

package/dist/generic/baseReranker.js

@@ -1,18 +1,70 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseReranker = void 0;
-const baseModel_1 = require("./baseModel");
-class BaseReranker extends baseModel_1.BaseModel {
+/**
+ * @fileoverview Abstract base class for AI reranker implementations.
+ *
+ * Provides the foundation for semantic reranking providers (Cohere, LLM-based, etc.)
+ * following the same patterns as BaseLLM and BaseEmbeddings.
+ *
+ * Implementations should:
+ * 1. Register with @RegisterClass(BaseReranker, 'ProviderName')
+ * 2. Implement the protected doRerank() method
+ * 3. Handle provider-specific API calls and response mapping
+ *
+ * @module @memberjunction/ai
+ * @since 3.0.0
+ */
+import { BaseModel } from './baseModel.js';
+/**
+ * Abstract base class for all reranker implementations.
+ * Extends BaseModel to follow MJ conventions for AI model classes.
+ *
+ * Provides common functionality including:
+ * - Input validation
+ * - Response standardization
+ * - Utility methods for sorting and filtering results
+ *
+ * Example usage:
+ * ```typescript
+ * @RegisterClass(BaseReranker, 'CohereReranker')
+ * export class CohereReranker extends BaseReranker {
+ *     protected async doRerank(params: RerankParams): Promise<RerankResult[]> {
+ *         // Call Cohere API and return results
+ *     }
+ * }
+ * ```
+ */
+export class BaseReranker extends BaseModel {
+    /**
+     * Create a new reranker instance.
+     * @param apiKey - API key for the reranking service (e.g., Cohere API key)
+     * @param modelName - Optional model name to use (provider-specific)
+     */
     constructor(apiKey, modelName) {
         super(apiKey);
         this._modelName = modelName || '';
     }
+    /**
+     * Get the model name used for this reranker
+     */
     get ModelName() {
         return this._modelName;
     }
+    /**
+     * Rerank documents based on their relevance to a query.
+     * This is the main entry point for reranking operations.
+     *
+     * The method:
+     * 1. Validates input parameters
+     * 2. Calls the provider-specific doRerank() implementation
+     * 3. Applies topK limit if specified
+     * 4. Returns standardized RerankResponse
+     *
+     * @param params - Reranking parameters including query and documents
+     * @returns Promise resolving to RerankResponse with reranked results
+     */
     async Rerank(params) {
         const startTime = Date.now();
         try {
+            // Validate input
             if (!params.query || params.query.trim().length === 0) {
                 return this.createErrorResponse('Query cannot be empty', startTime);
             }
@@ -24,15 +76,19 @@ class BaseReranker extends baseModel_1.BaseModel {
                     modelName: this._modelName
                 };
             }
+            // Validate all documents have required fields
             for (let i = 0; i < params.documents.length; i++) {
                 const doc = params.documents[i];
                 if (!doc.id || !doc.text) {
                     return this.createErrorResponse(`Document at index ${i} missing required field (id or text)`, startTime);
                 }
             }
+            // Call provider-specific implementation
             const results = await this.doRerank(params);
+            // Apply topK limit if specified
             const topK = params.topK || results.length;
             const limitedResults = results.slice(0, topK);
+            // Update rank values after limiting
             const rankedResults = limitedResults.map((r, idx) => ({
                 ...r,
                 rank: idx
@@ -50,6 +106,10 @@ class BaseReranker extends baseModel_1.BaseModel {
             return this.createErrorResponse(message, startTime);
         }
     }
+    /**
+     * Create a standardized error response.
+     * Used internally when validation fails or an exception occurs.
+     */
     createErrorResponse(message, startTime) {
         return {
             success: false,
@@ -59,12 +119,19 @@ class BaseReranker extends baseModel_1.BaseModel {
             modelName: this._modelName
         };
     }
+    /**
+     * Sort results by relevance score in descending order.
+     * Utility method for implementations.
+     */
     sortByRelevance(results) {
         return [...results].sort((a, b) => b.relevanceScore - a.relevanceScore);
     }
+    /**
+     * Filter results by minimum relevance threshold.
+     * Utility method for implementations that need to filter low-scoring results.
+     */
     filterByThreshold(results, minScore) {
         return results.filter(r => r.relevanceScore >= minScore);
     }
 }
-exports.BaseReranker = BaseReranker;
 //# sourceMappingURL=baseReranker.js.map

package/dist/generic/baseReranker.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseReranker.js","sourceRoot":"","sources":["../../src/generic/baseReranker.ts"],"names":[],"mappings":";;;AAeA,2CAAwC;AAsBxC,MAAsB,YAAa,SAAQ,qBAAS;IAQhD,YAAY,MAAc,EAAE,SAAkB;QAC1C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,EAAE,CAAC;IACtC,CAAC;IAKD,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAeM,KAAK,CAAC,MAAM,CAAC,MAAoB;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,IAAI,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,EAAE,SAAS,CAAC,CAAC;YACxE,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrD,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;oBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;iBAC7B,CAAC;YACN,CAAC;YAGD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;oBACvB,OAAO,IAAI,CAAC,mBAAmB,CAC3B,qBAAqB,CAAC,sCAAsC,EAC5D,SAAS,CACZ,CAAC;gBACN,CAAC;YACL,CAAC;YAGD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAG5C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;YAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAG9C,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;gBAClD,GAAG,CAAC;gBACJ,IAAI,EAAE,GAAG;aACZ,CAAC,CAAC,CAAC;YAEJ,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,aAAa;gBACtB,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;gBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;aAC7B,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,CAAC,KAAK,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IAqBS,mBAAmB,CAAC,OAAe,EAAE,SAAiB;QAC5D,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;YAClC,SAAS,EAAE,IAAI,CAAC,UAAU;SAC7B,CAAC;IACN,CAAC;IAMS,eAAe,CAAC,OAAuB;QAC7C,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC;IAC5E,CAAC;IAMS,iBAAiB,CAAC,OAAuB,EAAE,QAAgB;QACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,CAAC;IAC7D,CAAC;CACJ;AApID,oCAoIC"}
+{"version":3,"file":"baseReranker.js","sourceRoot":"","sources":["../../src/generic/baseReranker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAgB,YAAa,SAAQ,SAAS;IAGhD;;;;OAIG;IACH,YAAY,MAAc,EAAE,SAAkB;QAC1C,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,UAAU,GAAG,SAAS,IAAI,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,MAAM,CAAC,MAAoB;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,IAAI,CAAC;YACD,iBAAiB;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,EAAE,SAAS,CAAC,CAAC;YACxE,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrD,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,OAAO,EAAE,EAAE;oBACX,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;oBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;iBAC7B,CAAC;YACN,CAAC;YAED,8CAA8C;YAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAChC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;oBACvB,OAAO,IAAI,CAAC,mBAAmB,CAC3B,qBAAqB,CAAC,sCAAsC,EAC5D,SAAS,CACZ,CAAC;gBACN,CAAC;YACL,CAAC;YAED,wCAAwC;YACxC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAE5C,gCAAgC;YAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;YAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAE9C,oCAAoC;YACpC,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;gBAClD,GAAG,CAAC;gBACJ,IAAI,EAAE,GAAG;aACZ,CAAC,CAAC,CAAC;YAEJ,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,aAAa;gBACtB,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;gBAClC,SAAS,EAAE,IAAI,CAAC,UAAU;aAC7B,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,OAAO,CAAC,KAAK,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACxD,CAAC;IACL,CAAC;IAiBD;;;OAGG;IACO,mBAAmB,CAAC,OAAe,EAAE,SAAiB;QAC5D,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,EAAE;YACX,YAAY,EAAE,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;YAClC,SAAS,EAAE,IAAI,CAAC,UAAU;SAC7B,CAAC;IACN,CAAC;IAED;;;OAGG;IACO,eAAe,CAAC,OAAuB;QAC7C,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,OAAuB,EAAE,QAAgB;QACjE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,CAAC;IAC7D,CAAC;CACJ"}

package/dist/generic/baseVideo.d.ts

@@ -1,4 +1,9 @@
-import { BaseModel } from "./baseModel";
+import { BaseModel } from "./baseModel.js";
+/**
+ * Base class for all video generation models. Each AI model will have a sub-class implementing the abstract methods in this base class. Not all
+ * sub-classes will support all methods. If a method is not supported an exception will be thrown, use the GetSupportedMethods method to determine
+ * what methods are supported by a specific sub-class.
+ */
 export declare abstract class BaseVideoGenerator extends BaseModel {
     abstract CreateAvatarVideo(params: AvatarVideoParams): Promise<VideoResult>;
     abstract CreateVideoTranslation(params: VideoTranslationParams): Promise<VideoResult>;
@@ -7,7 +12,13 @@ export declare abstract class BaseVideoGenerator extends BaseModel {
 }
 export declare class VideoResult {
     success: boolean;
+    /**
+     * When success == false, this will contain the error message
+     */
     errorMessage?: string;
+    /**
+     * Platform-specific video ID for the generated video when success == true
+     */
     videoId: string;
 }
 export declare class AvatarInfo {
@@ -21,9 +32,21 @@ export declare class AvatarInfo {
 export declare class VideoTranslationParams {
 }
 export declare class AvatarVideoParams {
+    /**
+     * Title of the video for storage in the provider's history
+     */
     title: string;
+    /**
+     * Generate captions for the video if true, otherwise do not generate captions
+     */
     caption?: boolean;
+    /**
+     * Width of the requested video such as 1280 for 1280 pixels
+     */
     outputWidth: number;
+    /**
+     * Height of the requested video such as 720 for 720 pixels
+     */
     outputHeight: number;
     avatarId: string;
     scale: number;

package/dist/generic/baseVideo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"baseVideo.d.ts","sourceRoot":"","sources":["../../src/generic/baseVideo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAOxC,8BAAsB,kBAAmB,SAAQ,SAAS;aACtC,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;aAClE,sBAAsB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;aAC5E,UAAU,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;aACnC,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAC3D;AAED,qBAAa,WAAW;IACpB,OAAO,EAAE,OAAO,CAAC;IAIjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,qBAAa,UAAU;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,qBAAa,sBAAsB;CAElC;AAED,qBAAa,iBAAiB;IAI1B,KAAK,EAAE,MAAM,CAAC;IAId,OAAO,CAAC,EAAE,OAAO,CAAC;IAKlB,WAAW,EAAE,MAAM,CAAC;IAIpB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACvB"}
+{"version":3,"file":"baseVideo.d.ts","sourceRoot":"","sources":["../../src/generic/baseVideo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,8BAAsB,kBAAmB,SAAQ,SAAS;aACtC,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;aAClE,sBAAsB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC;aAC5E,UAAU,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;aACnC,mBAAmB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;CAC3D;AAED,qBAAa,WAAW;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,qBAAa,UAAU;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,qBAAa,sBAAsB;CAElC;AAED,qBAAa,iBAAiB;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACvB"}

package/dist/generic/baseVideo.js

@@ -1,20 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvatarVideoParams = exports.VideoTranslationParams = exports.AvatarInfo = exports.VideoResult = exports.BaseVideoGenerator = void 0;
-const baseModel_1 = require("./baseModel");
-class BaseVideoGenerator extends baseModel_1.BaseModel {
+import { BaseModel } from "./baseModel.js";
+/**
+ * Base class for all video generation models. Each AI model will have a sub-class implementing the abstract methods in this base class. Not all
+ * sub-classes will support all methods. If a method is not supported an exception will be thrown, use the GetSupportedMethods method to determine
+ * what methods are supported by a specific sub-class.
+ */
+export class BaseVideoGenerator extends BaseModel {
 }
-exports.BaseVideoGenerator = BaseVideoGenerator;
-class VideoResult {
+export class VideoResult {
 }
-exports.VideoResult = VideoResult;
-class AvatarInfo {
+export class AvatarInfo {
 }
-exports.AvatarInfo = AvatarInfo;
-class VideoTranslationParams {
+export class VideoTranslationParams {
 }
-exports.VideoTranslationParams = VideoTranslationParams;
-class AvatarVideoParams {
+export class AvatarVideoParams {
 }
-exports.AvatarVideoParams = AvatarVideoParams;
 //# sourceMappingURL=baseVideo.js.map

package/dist/generic/baseVideo.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseVideo.js","sourceRoot":"","sources":["../../src/generic/baseVideo.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AAOxC,MAAsB,kBAAmB,SAAQ,qBAAS;CAKzD;AALD,gDAKC;AAED,MAAa,WAAW;CAUvB;AAVD,kCAUC;AAED,MAAa,UAAU;CAOtB;AAPD,gCAOC;AAED,MAAa,sBAAsB;CAElC;AAFD,wDAEC;AAED,MAAa,iBAAiB;CA2B7B;AA3BD,8CA2BC"}
+{"version":3,"file":"baseVideo.js","sourceRoot":"","sources":["../../src/generic/baseVideo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;GAIG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,SAAS;CAKzD;AAED,MAAM,OAAO,WAAW;CAUvB;AAED,MAAM,OAAO,UAAU;CAOtB;AAED,MAAM,OAAO,sBAAsB;CAElC;AAED,MAAM,OAAO,iBAAiB;CA2B7B"}