llm-exe 1.0.2 → 2.0.0-beta.10

package/dist/interfaces/parser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parser.js","sourceRoot":"src/","sources":["interfaces/parser.ts"],"names":[],"mappings":""}

package/dist/interfaces/prompt.d.ts

@@ -1,22 +0,0 @@
-export type TextPromptType = "text";
-export type ChatPromptType = "chat";
-export type PromptType = TextPromptType | ChatPromptType;
-export type PromptHelper = {
-    name: string;
-    handler: (args: any) => any;
-};
-export type PromptPartial = {
-    name: string;
-    template: string;
-};
-export interface PromptTemplateOptions {
-    partials?: PromptPartial[];
-    helpers?: PromptHelper[];
-}
-export interface PromptOptions extends PromptTemplateOptions {
-    preFilters?: ((prompt: string) => string)[];
-    postFilters?: ((prompt: string) => string)[];
-}
-export interface ChatPromptOptions extends PromptOptions {
-    allowUnsafeUserTemplate?: boolean;
-}

package/dist/interfaces/prompt.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=prompt.js.map

package/dist/interfaces/prompt.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"prompt.js","sourceRoot":"src/","sources":["interfaces/prompt.ts"],"names":[],"mappings":""}

package/dist/interfaces/utils.d.ts

@@ -1,18 +0,0 @@
-export type PrimitiveValue = bigint | boolean | null | number | string | symbol | undefined;
-export type ObjectValue = PrimitiveValue | PlainObject | ObjectArray;
-export interface PlainObject {
-    [key: string]: ObjectValue;
-}
-export interface ObjectArray extends Array<ObjectValue> {
-}
-export interface ResultAttributes<R = any, A = Record<string, any>> {
-    result: R;
-    attributes: A;
-}
-export interface Serializable {
-    serialize?(): Record<string, any>;
-    deserialize?(): void;
-}
-export interface EmptyObject {
-    [key: string]: never;
-}

package/dist/interfaces/utils.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=utils.js.map

package/dist/interfaces/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"src/","sources":["interfaces/utils.ts"],"names":[],"mappings":""}

package/dist/llm/_base.d.ts

@@ -1,84 +0,0 @@
-import { BaseLlmOptions, PromptType } from "../types";
-import { BaseLlmOutput } from "../llm/output";
-/**
- * BaseLlm is an abstract class that provides a base structure for implementing
- * specific Low Latency Models (LLMs). It handles retries, timeouts, and metrics
- * for the calls made to the LLM.
- */
-export declare abstract class BaseLlm<C = any> {
-    /**
-     * A property to hold the client instance for the specific LLM.
-     */
-    protected client: C;
-    /**
-     * The type of prompt to create. Options are "text" or "chat"
-     */
-    protected promptType: PromptType;
-    /**
-     * The maximum time (in milliseconds) to wait for a response before timing out.
-     */
-    protected timeout: number;
-    /**
-     * The maximum delay (in milliseconds) between retries.
-     */
-    protected maxDelay: number;
-    /**
-     * The maximum number of retries before giving up.
-     */
-    protected numOfAttempts: number;
-    /**
-     * The jitter strategy to use between retries. Options are "none" or "full".
-     */
-    protected jitter: "none" | "full";
-    protected traceId: null | string;
-    /**
-     * An object to store metrics related to the LLM calls.
-     */
-    protected metrics: any;
-    /**
-     * The BaseLlm constructor takes an options object and sets up the instance.
-     * @param {BaseLlmOptions} options - The options object for LLM configuration.
-     */
-    constructor(options: BaseLlmOptions);
-    shouldRetry(_error: any, _stepNumber: number): boolean;
-    handleError(_error: any): void;
-    getPromptType(): PromptType;
-    /**
-     * getMetrics returns the metrics object for the LLM.
-     */
-    getMetrics(): any;
-    /**
-     * getMetadata - Used to return metrics and data about executions.
-     */
-    getMetadata(): {
-        traceId: string | null;
-        promptType: PromptType;
-        timeout: number;
-        jitter: "none" | "full";
-        maxDelay: number;
-        numOfAttempts: number;
-        metrics: any;
-    };
-    /**
-     * call makes a call to the specific LLM with input and returns the output.
-     * It also handles retries and updates the metrics.
-     * @param _input - The input to the LLM.
-     * @return The output from the LLM.
-     */
-    call(_input: any, ...args: any[]): Promise<BaseLlmOutput>;
-    /**
-     * _callWithRetry is a private method that handles retries and timeouts for the LLM call.
-     * @param _input - The input to the LLM.
-     * @return The result of the LLM call.
-     * @throws An error if the maximum number of retries is reached.
-     */
-    _callWithRetry(_input: any, ...args: any[]): Promise<any>;
-    /**
-     * _call is an method that must be implemented by subclasses to make the actual LLM call.
-     * @param {any} _input - The input to the LLM.
-     * @return The output from the LLM.
-     */
-    _call(_input: any, ..._args: any[]): Promise<BaseLlmOutput>;
-    withTraceId(traceId: string): this;
-    getTraceId(): string | null;
-}

package/dist/llm/_base.js

@@ -1,184 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseLlm = void 0;
-const exponential_backoff_1 = require("exponential-backoff");
-const utils_1 = require("../utils");
-const output_1 = require("../llm/output");
-/**
- * BaseLlm is an abstract class that provides a base structure for implementing
- * specific Low Latency Models (LLMs). It handles retries, timeouts, and metrics
- * for the calls made to the LLM.
- */
-class BaseLlm {
-    /**
-     * The BaseLlm constructor takes an options object and sets up the instance.
-     * @param {BaseLlmOptions} options - The options object for LLM configuration.
-     */
-    constructor(options) {
-        /**
-         * A property to hold the client instance for the specific LLM.
-         */
-        Object.defineProperty(this, "client", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The type of prompt to create. Options are "text" or "chat"
-         */
-        Object.defineProperty(this, "promptType", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The maximum time (in milliseconds) to wait for a response before timing out.
-         */
-        Object.defineProperty(this, "timeout", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The maximum delay (in milliseconds) between retries.
-         */
-        Object.defineProperty(this, "maxDelay", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The maximum number of retries before giving up.
-         */
-        Object.defineProperty(this, "numOfAttempts", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The jitter strategy to use between retries. Options are "none" or "full".
-         */
-        Object.defineProperty(this, "jitter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "traceId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * An object to store metrics related to the LLM calls.
-         */
-        Object.defineProperty(this, "metrics", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {
-                total_calls: 0,
-                total_call_success: 0,
-                total_call_retry: 0,
-                total_call_error: 0,
-                history: [],
-            }
-        });
-        this.traceId = options?.traceId || null;
-        this.client = null;
-        this.promptType = options?.promptType || "text";
-        this.timeout = options.timeout || 30000;
-        this.jitter = options.jitter || "none";
-        this.maxDelay = options.maxDelay || 5000;
-        this.numOfAttempts = options.numOfAttempts || 5;
-    }
-    shouldRetry(_error, _stepNumber) {
-        return true;
-    }
-    handleError(_error) {
-        throw _error;
-    }
-    getPromptType() {
-        return this.promptType;
-    }
-    /**
-     * getMetrics returns the metrics object for the LLM.
-     */
-    getMetrics() {
-        return { ...this.metrics };
-    }
-    /**
-     * getMetadata - Used to return metrics and data about executions.
-     */
-    getMetadata() {
-        return {
-            traceId: this.getTraceId(),
-            promptType: this.promptType,
-            timeout: this.timeout,
-            jitter: this.jitter,
-            maxDelay: this.maxDelay,
-            numOfAttempts: this.numOfAttempts,
-            metrics: this.getMetrics(),
-        };
-    }
-    /**
-     * call makes a call to the specific LLM with input and returns the output.
-     * It also handles retries and updates the metrics.
-     * @param _input - The input to the LLM.
-     * @return The output from the LLM.
-     */
-    async call(_input, ...args) {
-        return this._callWithRetry(_input, ...args);
-    }
-    /**
-     * _callWithRetry is a private method that handles retries and timeouts for the LLM call.
-     * @param _input - The input to the LLM.
-     * @return The result of the LLM call.
-     * @throws An error if the maximum number of retries is reached.
-     */
-    async _callWithRetry(_input, ...args) {
-        try {
-            this.metrics.total_calls++;
-            const result = await (0, exponential_backoff_1.backOff)(() => (0, utils_1.asyncCallWithTimeout)(this._call(_input, ...args), this.timeout), {
-                startingDelay: 0,
-                maxDelay: this.maxDelay,
-                numOfAttempts: this.numOfAttempts,
-                jitter: this.jitter,
-                retry: (_error, _stepNumber) => {
-                    this.metrics.total_call_retry++;
-                    console.log(`Handler timeout after ${this.timeout}. Retrying...`);
-                    return true;
-                },
-            });
-            this.metrics.total_call_success++;
-            return result;
-        }
-        catch (error) {
-            this.metrics.total_call_error++;
-            this.handleError(error);
-        }
-    }
-    /**
-     * _call is an method that must be implemented by subclasses to make the actual LLM call.
-     * @param {any} _input - The input to the LLM.
-     * @return The output from the LLM.
-     */
-    async _call(_input, ..._args) {
-        return new output_1.OutputDefault(undefined);
-    }
-    withTraceId(traceId) {
-        this.traceId = traceId;
-        return this;
-    }
-    getTraceId() {
-        return this.traceId;
-    }
-}
-exports.BaseLlm = BaseLlm;
-//# sourceMappingURL=_base.js.map

package/dist/llm/_base.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_base.js","sourceRoot":"src/","sources":["llm/_base.ts"],"names":[],"mappings":";;;AAAA,6DAA8C;AAE9C,mCAA+C;AAC/C,yCAA4D;AAE5D;;;;GAIG;AACH,MAAsB,OAAO;IA2C3B;;;OAGG;IACH,YAAY,OAAuB;QA9CnC;;WAEG;QACH;;;;;WAAoB;QAEpB;;WAEG;QACH;;;;;WAAiC;QAEjC;;WAEG;QACH;;;;;WAA0B;QAE1B;;WAEG;QACH;;;;;WAA2B;QAE3B;;WAEG;QACH;;;;;WAAgC;QAEhC;;WAEG;QACH;;;;;WAAkC;QAElC;;;;;WAAkC;QAClC;;WAEG;QACH;;;;mBAAyB;gBACvB,WAAW,EAAE,CAAC;gBACd,kBAAkB,EAAE,CAAC;gBACrB,gBAAgB,EAAE,CAAC;gBACnB,gBAAgB,EAAE,CAAC;gBACnB,OAAO,EAAE,EAAE;aACZ;WAAC;QAOA,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,IAAS,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,MAAM,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,WAAW,CAAC,MAAW,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,WAAW,CAAC,MAAW;QACrB,MAAM,MAAM,CAAA;IACd,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAAW,EACX,GAAG,IAAW;QAEd,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,MAAW,EAAE,GAAG,IAAW;QAC9C,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAO,EAC1B,GAAG,EAAE,CACH,IAAA,4BAAoB,EAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,EACjE;gBACE,aAAa,EAAE,CAAC;gBAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,CAAC,MAAW,EAAE,WAAmB,EAAE,EAAE;oBAC1C,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;oBAChC,OAAO,CAAC,GAAG,CAAC,yBAAyB,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC;oBAClE,OAAO,IAAI,CAAA;gBACb,CAAC;aACF,CACF,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;SACxB;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CACT,MAAW,EACX,GAAG,KAAY;QAEf,OAAO,IAAI,sBAAa,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IACD,WAAW,CAAC,OAAgB;QAC1B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AA1JD,0BA0JC"}

package/dist/llm/index.d.ts

@@ -1,2 +0,0 @@
-export { BaseLlm } from "./_base";
-export { createLlmOpenAi, OpenAI } from "./openai";

package/dist/llm/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAI = exports.createLlmOpenAi = exports.BaseLlm = void 0;
-var _base_1 = require("./_base");
-Object.defineProperty(exports, "BaseLlm", { enumerable: true, get: function () { return _base_1.BaseLlm; } });
-var openai_1 = require("./openai");
-Object.defineProperty(exports, "createLlmOpenAi", { enumerable: true, get: function () { return openai_1.createLlmOpenAi; } });
-Object.defineProperty(exports, "OpenAI", { enumerable: true, get: function () { return openai_1.OpenAI; } });
-//# sourceMappingURL=index.js.map

package/dist/llm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["llm/index.ts"],"names":[],"mappings":";;;AAAA,iCAAkC;AAAzB,gGAAA,OAAO,OAAA;AAChB,mCAAmD;AAA1C,yGAAA,eAAe,OAAA;AAAE,gGAAA,MAAM,OAAA"}

package/dist/llm/openai.d.ts

@@ -1,96 +0,0 @@
-import { OpenAIApi } from "openai";
-import { IChatMessages, OpenAIModelName, OpenAIOptions, OpenAiLlmExecutorOptions } from "../types";
-import { BaseLlm } from "./_base";
-import { OutputOpenAIChat } from "../llm/output";
-import { OutputOpenAICompletion } from "./output/openai";
-/**
- * Create a new instance of the OpenAI API wrapper.
- * @param options - Configuration options for the OpenAI API wrapper.
- * @returns - A new instance of the OpenAI API wrapper class.
- */
-export declare function createLlmOpenAi(options: OpenAIOptions): OpenAI;
-/**
- * A class that extends BaseLlm and provides functionality for the OpenAI API.
- */
-export declare class OpenAI extends BaseLlm<OpenAIApi> {
-    private model;
-    private temperature;
-    private maxTokens;
-    private topP;
-    private n;
-    private stream;
-    private stop;
-    private presencePenalty;
-    private frequencyPenalty;
-    private logitBias;
-    private user;
-    /**
-     * Constructor for the OpenAI class.
-     * @param {OpenAIOptions} options - Configuration options for the OpenAI API wrapper.
-     */
-    constructor(options: OpenAIOptions);
-    /**
-     * Get the total prompt and completion tokens across all calls to the API.
-     * @returns - An object with total prompt and completion tokens.
-     */
-    getMetrics(): {
-        total_completionTokens: number;
-        total_promptTokens: number;
-        total_totalTokens: number;
-    };
-    /**
-     * Calculate the API call cost based on input and output tokens.
-     * @param input_tokens - The number of input tokens.
-     * @param output_tokens=0 - The number of output tokens (defaults to 0).
-     * @returns An object for input/output tokens and cost.
-     */
-    calculatePrice(input_tokens: number, output_tokens?: number): {
-        input_cost: number;
-        output_cost: number;
-        total_cost: number;
-    };
-    /**
-     * Log a table containing usage metrics for the OpenAI API.
-     */
-    logMetrics(): void;
-    /**
-     * Wrapper function to call chat/completion with the specified input.
-     * @private
-     * @param input - The input for the chat/completion API.
-     * @returns The chat/completion response from the API.
-     */
-    _call(input: string | IChatMessages, arg2?: OpenAiLlmExecutorOptions): Promise<OutputOpenAIChat | OutputOpenAICompletion>;
-    /**
-     * Communicate with the OpenAI Chat API.
-     * @param messages - A list of message objects for the API call.
-     * @returns The chat response from the API.
-     */
-    chat(messages: IChatMessages, _args?: OpenAiLlmExecutorOptions): Promise<OutputOpenAIChat>;
-    /**
-     * Communicate with the OpenAI Completion API.
-     * @param messages - A list of message objects for the API call.
-     * @returns The chat response from the API.
-     */
-    completion(prompt: string): Promise<OutputOpenAICompletion>;
-    getMetadata(): {
-        traceId: string | null;
-        promptType: import("../types").PromptType;
-        timeout: number;
-        jitter: "none" | "full";
-        maxDelay: number;
-        numOfAttempts: number;
-        metrics: any;
-    } & {
-        model: OpenAIModelName;
-        temperature: number;
-        max_tokens: number;
-        topP: number | null;
-        n: number | null;
-        stream: boolean | null;
-        stop: any;
-        presencePenalty: number | null;
-        frequencyPenalty: number | null;
-        logitBias: object | null;
-        user: string;
-    };
-}