langchain 0.0.4 → 0.0.5

package/dist/cjs/embeddings/openai.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAIEmbeddings = void 0;
+const exponential_backoff_1 = require("exponential-backoff");
+const util_1 = require("../util");
+const base_1 = require("./base");
+let Configuration = null;
+let OpenAIApi = null;
+try {
+    // eslint-disable-next-line global-require
+    ({ Configuration, OpenAIApi } = require("openai"));
+}
+catch (_a) {
+    // ignore error
+}
+class OpenAIEmbeddings extends base_1.Embeddings {
+    constructor(fields) {
+        var _a, _b, _c;
+        super();
+        Object.defineProperty(this, "modelName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "text-embedding-ada-002"
+        });
+        Object.defineProperty(this, "batchSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 20
+        });
+        Object.defineProperty(this, "maxRetries", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 6
+        });
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        if (Configuration === null || OpenAIApi === null) {
+            throw new Error("Please install openai as a dependency with, e.g. `npm install -S openai`");
+        }
+        this.modelName = (_a = fields === null || fields === void 0 ? void 0 : fields.modelName) !== null && _a !== void 0 ? _a : this.modelName;
+        this.batchSize = (_b = fields === null || fields === void 0 ? void 0 : fields.batchSize) !== null && _b !== void 0 ? _b : this.batchSize;
+        const clientConfig = new Configuration({
+            apiKey: (_c = fields === null || fields === void 0 ? void 0 : fields.openAIApiKey) !== null && _c !== void 0 ? _c : process.env.OPENAI_API_KEY,
+        });
+        this.client = new OpenAIApi(clientConfig);
+    }
+    async embedDocuments(texts) {
+        const subPrompts = (0, util_1.chunkArray)(texts, this.batchSize);
+        const embeddings = [];
+        for (let i = 0; i < subPrompts.length; i += 1) {
+            const input = subPrompts[i];
+            const { data } = await this.embeddingWithRetry({
+                model: this.modelName,
+                input,
+            });
+            for (let j = 0; j < input.length; j += 1) {
+                embeddings.push(data.data[j].embedding);
+            }
+        }
+        return embeddings;
+    }
+    async embedQuery(text) {
+        const { data } = await this.embeddingWithRetry({
+            model: this.modelName,
+            input: text,
+        });
+        return data.data[0].embedding;
+    }
+    embeddingWithRetry(request) {
+        const makeCompletionRequest = () => this.client.createEmbedding(request);
+        return (0, exponential_backoff_1.backOff)(makeCompletionRequest, {
+            startingDelay: 4,
+            maxDelay: 10,
+            numOfAttempts: this.maxRetries,
+        });
+    }
+}
+exports.OpenAIEmbeddings = OpenAIEmbeddings;
+//# sourceMappingURL=openai.js.map

package/dist/cjs/embeddings/openai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai.js","sourceRoot":"","sources":["../../../embeddings/openai.ts"],"names":[],"mappings":";;;AAKA,6DAA8C;AAC9C,kCAAqC;AACrC,iCAAoC;AAEpC,IAAI,aAAa,GAAiC,IAAI,CAAC;AACvD,IAAI,SAAS,GAA6B,IAAI,CAAC;AAE/C,IAAI;IACF,0CAA0C;IAC1C,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;CACpD;AAAC,WAAM;IACN,eAAe;CAChB;AAMD,MAAa,gBAAiB,SAAQ,iBAAU;IAS9C,YACE,MAKC;;QAED,KAAK,EAAE,CAAC;QAhBV;;;;mBAAY,wBAAwB;WAAC;QAErC;;;;mBAAY,EAAE;WAAC;QAEf;;;;mBAAa,CAAC;WAAC;QAEf;;;;;WAA2B;QAWzB,IAAI,aAAa,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,EAAE;YAChD,MAAM,IAAI,KAAK,CACb,0EAA0E,CAC3E,CAAC;SACH;QAED,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,MAAM,YAAY,GAAG,IAAI,aAAa,CAAC;YACrC,MAAM,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,YAAY,mCAAI,OAAO,CAAC,GAAG,CAAC,cAAc;SAC3D,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,YAAY,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,KAAe;QAClC,MAAM,UAAU,GAAG,IAAA,iBAAU,EAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAErD,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC7C,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;YAC5B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC;gBAC7C,KAAK,EAAE,IAAI,CAAC,SAAS;gBACrB,KAAK;aACN,CAAC,CAAC;YACH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;gBACxC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;aACzC;SACF;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAY;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC;YAC7C,KAAK,EAAE,IAAI,CAAC,SAAS;YACrB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAChC,CAAC;IAEO,kBAAkB,CAAC,OAA+B;QACxD,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACzE,OAAO,IAAA,6BAAO,EAAC,qBAAqB,EAAE;YACpC,aAAa,EAAE,CAAC;YAChB,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,IAAI,CAAC,UAAU;SAC/B,CAAC,CAAC;IACL,CAAC;CACF;AAnED,4CAmEC"}

package/dist/cjs/embeddings/tests/openai.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/embeddings/tests/openai.test.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const openai_1 = require("../openai");
+(0, globals_1.test)("Test OpenAIEmbeddings.embedQuery", async () => {
+    const embeddings = new openai_1.OpenAIEmbeddings();
+    const res = await embeddings.embedQuery("Hello world");
+    (0, globals_1.expect)(typeof res[0]).toBe("number");
+});
+(0, globals_1.test)("Test OpenAIEmbeddings.embedDocuments", async () => {
+    const embeddings = new openai_1.OpenAIEmbeddings();
+    const res = await embeddings.embedDocuments(["Hello world", "Bye bye"]);
+    (0, globals_1.expect)(res).toHaveLength(2);
+    (0, globals_1.expect)(typeof res[0][0]).toBe("number");
+    (0, globals_1.expect)(typeof res[1][0]).toBe("number");
+});
+//# sourceMappingURL=openai.test.js.map

package/dist/cjs/embeddings/tests/openai.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai.test.js","sourceRoot":"","sources":["../../../../embeddings/tests/openai.test.ts"],"names":[],"mappings":";;AAAA,2CAA6C;AAC7C,sCAA6C;AAE7C,IAAA,cAAI,EAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;IAClD,MAAM,UAAU,GAAG,IAAI,yBAAgB,EAAE,CAAC;IAC1C,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACvD,IAAA,gBAAM,EAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC;AAEH,IAAA,cAAI,EAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;IACtD,MAAM,UAAU,GAAG,IAAI,yBAAgB,EAAE,CAAC;IAC1C,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;IACxE,IAAA,gBAAM,EAAC,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAA,gBAAM,EAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxC,IAAA,gBAAM,EAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAC1C,CAAC,CAAC,CAAC"}

package/dist/cjs/llms/base.d.ts

@@ -2,22 +2,63 @@ import { LLMCallbackManager, LLMResult } from "./index";
 export type SerializedLLM = {
     _type: string;
 } & Record<string, any>;
+/**
+ * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
+ */
 export declare abstract class BaseLLM {
+    /**
+     * The name of the LLM class
+     */
     name: string;
     cache?: boolean;
     callbackManager: LLMCallbackManager;
+    /**
+     * Whether to print out response text.
+     */
     verbose?: boolean;
     constructor(callbackManager?: LLMCallbackManager, verbose?: boolean);
+    /**
+     * Run the LLM on the given prompts and input.
+     */
     abstract _generate(prompts: string[], stop?: string[]): Promise<LLMResult>;
+    /** @ignore */
     _generateUncached(prompts: string[], stop?: string[]): Promise<LLMResult>;
+    /**
+     * Run the LLM on the given propmts an input, handling caching.
+     */
     generate(prompts: string[], stop?: string[]): Promise<LLMResult>;
+    /**
+     * Convenience wrapper for {@link generate} that takes in a single string prompt and returns a single string output.
+     */
     call(prompt: string, stop?: string[]): Promise<string>;
+    /**
+     * Get the identifying parameters of the LLM.
+     */
     _identifyingParams(): Record<string, any>;
+    /**
+     * Return the string type key uniquely identifying this class of LLM.
+     */
     abstract _llmType(): string;
+    /**
+     * Return a json-like object representing this LLM.
+     */
     serialize(): SerializedLLM;
+    /**
+     * Load an LLM from a json-like object describing it.
+     */
     static deserialize(data: SerializedLLM): Promise<BaseLLM>;
 }
+/**
+ * LLM class that provides a simpler interface to subclass than {@link BaseLLM}.
+ *
+ * Requires only implementing a simpler {@link _call} method instead of {@link _generate}.
+ *
+ * @augments BaseLLM
+ */
 export declare abstract class LLM extends BaseLLM {
+    /**
+     * Run the LLM on the given prompt and input.
+     */
     abstract _call(prompt: string, stop?: string[]): Promise<string>;
     _generate(prompts: string[], stop?: string[]): Promise<LLMResult>;
 }

package/dist/cjs/llms/base.js

@@ -1,24 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LLM = exports.BaseLLM = void 0;
 const index_1 = require("./index");
@@ -36,8 +16,14 @@ const getCallbackManager = () => ({
 });
 const getVerbosity = () => true;
 const cache = new cache_1.InMemoryCache();
+/**
+ * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
+ */
 class BaseLLM {
     constructor(callbackManager, verbose) {
+        /**
+         * The name of the LLM class
+         */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
@@ -56,6 +42,9 @@ class BaseLLM {
             writable: true,
             value: void 0
         });
+        /**
+         * Whether to print out response text.
+         */
         Object.defineProperty(this, "verbose", {
             enumerable: true,
             configurable: true,
@@ -65,94 +54,110 @@ class BaseLLM {
         this.callbackManager = callbackManager !== null && callbackManager !== void 0 ? callbackManager : getCallbackManager();
         this.verbose = verbose !== null && verbose !== void 0 ? verbose : getVerbosity();
     }
-    _generateUncached(prompts, stop) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.callbackManager.handleStart({ name: this.name }, prompts, this.verbose);
-            let output;
-            try {
-                output = yield this._generate(prompts, stop);
-            }
-            catch (err) {
-                this.callbackManager.handleError(`${err}`, this.verbose);
-                throw err;
-            }
-            this.callbackManager.handleEnd(output, this.verbose);
-            return output;
-        });
+    /** @ignore */
+    async _generateUncached(prompts, stop) {
+        this.callbackManager.handleStart({ name: this.name }, prompts, this.verbose);
+        let output;
+        try {
+            output = await this._generate(prompts, stop);
+        }
+        catch (err) {
+            this.callbackManager.handleError(`${err}`, this.verbose);
+            throw err;
+        }
+        this.callbackManager.handleEnd(output, this.verbose);
+        return output;
     }
-    generate(prompts, stop) {
+    /**
+     * Run the LLM on the given propmts an input, handling caching.
+     */
+    async generate(prompts, stop) {
         var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!Array.isArray(prompts)) {
-                throw new Error("Argument 'prompts' is expected to be a string[]");
-            }
-            if (this.cache === true && cache === null) {
-                throw new Error("Requested cache, but no cache found");
-            }
-            if (cache === null || this.cache === false) {
-                return this._generateUncached(prompts, stop);
-            }
-            const params = this.serialize();
-            params.stop = stop;
-            const llmStringKey = `${Object.entries(params).sort()}`;
-            const missingPromptIndices = [];
-            const generations = prompts.map((prompt, index) => {
-                const result = cache.lookup(prompt, llmStringKey);
-                if (!result) {
-                    missingPromptIndices.push(index);
-                }
-                return result;
-            });
-            let llmOutput = {};
-            if (missingPromptIndices.length > 0) {
-                const results = yield this._generateUncached(missingPromptIndices.map((i) => prompts[i]), stop);
-                results.generations.forEach((generation, index) => {
-                    const promptIndex = missingPromptIndices[index];
-                    generations[promptIndex] = generation;
-                    cache.update(prompts[promptIndex], llmStringKey, generation);
-                });
-                llmOutput = (_a = results.llmOutput) !== null && _a !== void 0 ? _a : {};
+        if (!Array.isArray(prompts)) {
+            throw new Error("Argument 'prompts' is expected to be a string[]");
+        }
+        if (this.cache === true && cache === null) {
+            throw new Error("Requested cache, but no cache found");
+        }
+        if (cache === null || this.cache === false) {
+            return this._generateUncached(prompts, stop);
+        }
+        const params = this.serialize();
+        params.stop = stop;
+        const llmStringKey = `${Object.entries(params).sort()}`;
+        const missingPromptIndices = [];
+        const generations = prompts.map((prompt, index) => {
+            const result = cache.lookup(prompt, llmStringKey);
+            if (!result) {
+                missingPromptIndices.push(index);
             }
-            return { generations, llmOutput };
+            return result;
         });
+        let llmOutput = {};
+        if (missingPromptIndices.length > 0) {
+            const results = await this._generateUncached(missingPromptIndices.map((i) => prompts[i]), stop);
+            results.generations.forEach((generation, index) => {
+                const promptIndex = missingPromptIndices[index];
+                generations[promptIndex] = generation;
+                cache.update(prompts[promptIndex], llmStringKey, generation);
+            });
+            llmOutput = (_a = results.llmOutput) !== null && _a !== void 0 ? _a : {};
+        }
+        return { generations, llmOutput };
     }
-    call(prompt, stop) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { generations } = yield this.generate([prompt], stop);
-            return generations[0][0].text;
-        });
+    /**
+     * Convenience wrapper for {@link generate} that takes in a single string prompt and returns a single string output.
+     */
+    async call(prompt, stop) {
+        const { generations } = await this.generate([prompt], stop);
+        return generations[0][0].text;
     }
+    /**
+     * Get the identifying parameters of the LLM.
+     */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     _identifyingParams() {
         return {};
     }
+    /**
+     * Return a json-like object representing this LLM.
+     */
     serialize() {
-        return Object.assign(Object.assign({}, this._identifyingParams()), { _type: this._llmType() });
+        return {
+            ...this._identifyingParams(),
+            _type: this._llmType(),
+        };
     }
-    static deserialize(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { _type } = data, rest = __rest(data, ["_type"]);
-            const Cls = {
-                openai: index_1.OpenAI,
-            }[_type];
-            if (Cls === undefined) {
-                throw new Error(`Cannot load  LLM with type ${_type}`);
-            }
-            return new Cls(rest);
-        });
+    /**
+     * Load an LLM from a json-like object describing it.
+     */
+    static async deserialize(data) {
+        const { _type, ...rest } = data;
+        const Cls = {
+            openai: index_1.OpenAI,
+        }[_type];
+        if (Cls === undefined) {
+            throw new Error(`Cannot load  LLM with type ${_type}`);
+        }
+        return new Cls(rest);
     }
 }
 exports.BaseLLM = BaseLLM;
+/**
+ * LLM class that provides a simpler interface to subclass than {@link BaseLLM}.
+ *
+ * Requires only implementing a simpler {@link _call} method instead of {@link _generate}.
+ *
+ * @augments BaseLLM
+ */
 class LLM extends BaseLLM {
-    _generate(prompts, stop) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const generations = [];
-            for (let i = 0; i < prompts.length; i += 1) {
-                const text = yield this._call(prompts[i], stop);
-                generations.push([{ text }]);
-            }
-            return { generations };
-        });
+    async _generate(prompts, stop) {
+        const generations = [];
+        for (let i = 0; i < prompts.length; i += 1) {
+            const text = await this._call(prompts[i], stop);
+            generations.push([{ text }]);
+        }
+        return { generations };
     }
 }
 exports.LLM = LLM;

package/dist/cjs/llms/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../llms/base.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAgE;AAChE,oCAAoD;AAEpD,MAAM,kBAAkB,GAAG,GAAuB,EAAE,CAAC,CAAC;IACpD,WAAW,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACxB,qBAAqB;IACvB,CAAC;IACD,SAAS,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACtB,qBAAqB;IACvB,CAAC;IACD,WAAW,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACxB,qBAAqB;IACvB,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAEhC,MAAM,KAAK,GAAc,IAAI,qBAAa,EAAE,CAAC;AAO7C,MAAsB,OAAO;IAS3B,YAAY,eAAoC,EAAE,OAAiB;QARnE;;;;;WAAa;QAEb;;;;;WAAgB;QAEhB;;;;;WAAoC;QAEpC;;;;mBAAoB,KAAK;WAAC;QAGxB,IAAI,CAAC,eAAe,GAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,kBAAkB,EAAE,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,YAAY,EAAE,CAAC;IAC3C,CAAC;IAIK,iBAAiB,CACrB,OAAiB,EACjB,IAAe;;YAEf,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EACnB,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;YACF,IAAI,MAAM,CAAC;YACX,IAAI;gBACF,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aAC9C;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACzD,MAAM,GAAG,CAAC;aACX;YAED,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACrD,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAEK,QAAQ,CAAC,OAAiB,EAAE,IAAe;;;YAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC3B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;aACpE;YAED,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YAED,IAAI,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE;gBAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aAC9C;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;YAEnB,MAAM,YAAY,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;YACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;YAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAChD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;gBAClD,IAAI,CAAC,MAAM,EAAE;oBACX,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBAClC;gBACD,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,IAAI,SAAS,GAAG,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC1C,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAC3C,IAAI,CACL,CAAC;gBACF,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;oBAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;oBAChD,WAAW,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;oBACtC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;gBAC/D,CAAC,CAAC,CAAC;gBACH,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC;aACrC;YAED,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,CAAC;;KAChD;IAEK,IAAI,CAAC,MAAc,EAAE,IAAe;;YACxC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;YAC5D,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChC,CAAC;KAAA;IAED,8DAA8D;IAC9D,kBAAkB;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAID,SAAS;QACP,uCACK,IAAI,CAAC,kBAAkB,EAAE,KAC5B,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,IACtB;IACJ,CAAC;IAED,MAAM,CAAO,WAAW,CAAC,IAAmB;;YAC1C,MAAM,EAAE,KAAK,KAAc,IAAI,EAAb,IAAI,UAAK,IAAI,EAAzB,SAAkB,CAAO,CAAC;YAChC,MAAM,GAAG,GAAG;gBACV,MAAM,EAAE,cAAM;aACf,CAAC,KAAK,CAAC,CAAC;YACT,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;aACxD;YACD,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;KAAA;CAGF;AA/GD,0BA+GC;AAED,MAAsB,GAAI,SAAQ,OAAO;IAGjC,SAAS,CAAC,OAAiB,EAAE,IAAe;;YAChD,MAAM,WAAW,GAAG,EAAE,CAAC;YACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;gBAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;gBAChD,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;aAC9B;YACD,OAAO,EAAE,WAAW,EAAE,CAAC;QACzB,CAAC;KAAA;CACF;AAXD,kBAWC"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../llms/base.ts"],"names":[],"mappings":";;;AAAA,mCAAgE;AAChE,oCAAoD;AAEpD,MAAM,kBAAkB,GAAG,GAAuB,EAAE,CAAC,CAAC;IACpD,WAAW,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACxB,qBAAqB;IACvB,CAAC;IACD,SAAS,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACtB,qBAAqB;IACvB,CAAC;IACD,WAAW,EAAE,CAAC,GAAG,KAAK,EAAE,EAAE;QACxB,qBAAqB;IACvB,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;AAEhC,MAAM,KAAK,GAAc,IAAI,qBAAa,EAAE,CAAC;AAO7C;;GAEG;AACH,MAAsB,OAAO;IAe3B,YAAY,eAAoC,EAAE,OAAiB;QAdnE;;WAEG;QACH;;;;;WAAa;QAEb;;;;;WAAgB;QAEhB;;;;;WAAoC;QAEpC;;WAEG;QACH;;;;mBAAoB,KAAK;WAAC;QAGxB,IAAI,CAAC,eAAe,GAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,kBAAkB,EAAE,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,YAAY,EAAE,CAAC;IAC3C,CAAC;IAOD,cAAc;IACd,KAAK,CAAC,iBAAiB,CACrB,OAAiB,EACjB,IAAe;QAEf,IAAI,CAAC,eAAe,CAAC,WAAW,CAC9B,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EACnB,OAAO,EACP,IAAI,CAAC,OAAO,CACb,CAAC;QACF,IAAI,MAAM,CAAC;QACX,IAAI;YACF,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAC9C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACzD,MAAM,GAAG,CAAC;SACX;QAED,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAiB,EAAE,IAAe;;QAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QAED,IAAI,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE;YAC1C,OAAO,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAC9C;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAChC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAEnB,MAAM,YAAY,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACxD,MAAM,oBAAoB,GAAa,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAChD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YAClD,IAAI,CAAC,MAAM,EAAE;gBACX,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAClC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAI,SAAS,GAAG,EAAE,CAAC;QACnB,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC1C,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAC3C,IAAI,CACL,CAAC;YACF,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;gBAChD,MAAM,WAAW,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBAChD,WAAW,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC;gBACtC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YACH,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,EAAE,CAAC;SACrC;QAED,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,IAAe;QACxC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,8DAA8D;IAC9D,kBAAkB;QAChB,OAAO,EAAE,CAAC;IACZ,CAAC;IAOD;;OAEG;IACH,SAAS;QACP,OAAO;YACL,GAAG,IAAI,CAAC,kBAAkB,EAAE;YAC5B,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE;SACvB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAmB;QAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,GAAG,GAAG;YACV,MAAM,EAAE,cAAM;SACf,CAAC,KAAK,CAAC,CAAC;QACT,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;SACxD;QACD,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;CAGF;AA3ID,0BA2IC;AAED;;;;;;GAMG;AACH,MAAsB,GAAI,SAAQ,OAAO;IAMvC,KAAK,CAAC,SAAS,CAAC,OAAiB,EAAE,IAAe;QAChD,MAAM,WAAW,GAAG,EAAE,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAChD,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;SAC9B;QACD,OAAO,EAAE,WAAW,EAAE,CAAC;IACzB,CAAC;CACF;AAdD,kBAcC"}

package/dist/cjs/llms/index.d.ts

@@ -8,11 +8,30 @@ export type LLMCallbackManager = {
     handleError: (err: string, verbose?: boolean) => void;
     handleEnd: (output: LLMResult, verbose?: boolean) => void;
 };
+/**
+ * Output of a single generation.
+ */
 export type Generation = {
+    /**
+     * Generated text output
+     */
     text: string;
+    /**
+     * Raw generation info response from the provider.
+     * May include things like reason for finishing (e.g. in {@link OpenAI})
+     */
     generationInfo?: Record<string, any>;
 };
+/**
+ * Contains all relevant information returned by an LLM.
+ */
 export type LLMResult = {
+    /**
+     * List of the things generated. Each input could have multiple {@link Generation | generations}, hence this is a list of lists.
+     */
     generations: Generation[][];
+    /**
+     * Dictionary of arbitrary LLM-provider specific output.
+     */
     llmOutput?: Record<string, any>;
 };

package/dist/cjs/llms/load.d.ts

@@ -1,3 +1,11 @@
 import { BaseLLM } from "./base";
-export declare const loadLLM: typeof BaseLLM.deserialize;
-export declare const loadLLMFromFile: (file: string) => Promise<BaseLLM>;
+/**
+ * Load an LLM from a local file.
+ *
+ * @example
+ * ```ts
+ * import { loadLLM } from "langchain/llms";
+ * const model = await loadLLM("/path/to/llm.json");
+ * ```
+ */
+export declare const loadLLM: (file: string) => Promise<BaseLLM>;

package/dist/cjs/llms/load.js

@@ -1,9 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadLLMFromFile = exports.loadLLM = void 0;
+exports.loadLLM = void 0;
 const base_1 = require("./base");
 const util_1 = require("../util");
-exports.loadLLM = base_1.BaseLLM.deserialize;
-const loadLLMFromFile = (file) => (0, exports.loadLLM)((0, util_1.parseFileConfig)(file));
-exports.loadLLMFromFile = loadLLMFromFile;
+/**
+ * Load an LLM from a local file.
+ *
+ * @example
+ * ```ts
+ * import { loadLLM } from "langchain/llms";
+ * const model = await loadLLM("/path/to/llm.json");
+ * ```
+ */
+const loadLLM = (file) => base_1.BaseLLM.deserialize((0, util_1.parseFileConfig)(file));
+exports.loadLLM = loadLLM;
 //# sourceMappingURL=load.js.map

package/dist/cjs/llms/load.js.map

@@ -1 +1 @@
-{"version":3,"file":"load.js","sourceRoot":"","sources":["../../../llms/load.ts"],"names":[],"mappings":";;;AAAA,iCAAiC;AACjC,kCAA0C;AAE7B,QAAA,OAAO,GAAG,cAAO,CAAC,WAAW,CAAC;AACpC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,eAAO,EAAC,IAAA,sBAAe,EAAC,IAAI,CAAC,CAAC,CAAC;AAAnE,QAAA,eAAe,mBAAoD"}
+{"version":3,"file":"load.js","sourceRoot":"","sources":["../../../llms/load.ts"],"names":[],"mappings":";;;AAAA,iCAAiC;AACjC,kCAA0C;AAE1C;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CACtC,cAAO,CAAC,WAAW,CAAC,IAAA,sBAAe,EAAC,IAAI,CAAC,CAAC,CAAC;AADhC,QAAA,OAAO,WACyB"}

package/dist/cjs/llms/openai.d.ts

@@ -1,17 +1,62 @@
 import type { CreateCompletionRequest } from "openai";
 import { BaseLLM, LLMResult, LLMCallbackManager } from ".";
 interface ModelParams {
+    /** Sampling temperature to use */
     temperature: number;
+    /**
+     * Maximum number of tokens to generate in the completion. -1 returns as many
+     * tokens as possible given the prompt and the model's maximum context size.
+     */
     maxTokens: number;
+    /** Total probability mass of tokens to consider at each step */
     topP: number;
+    /** Penalizes repeated tokens according to frequency */
     frequencyPenalty: number;
+    /** Penalizes repeated tokens */
     presencePenalty: number;
+    /** Number of completions to generate for each prompt */
     n: number;
+    /** Generates `bestOf` completions server side and returns the "best" */
     bestOf: number;
+    /** Dictionary used to adjust the probability of specific tokens being generated */
     logitBias?: Record<string, number>;
 }
+/**
+ * Input to OpenAI class.
+ * @augments ModelParams
+ */
+interface OpenAIInput extends ModelParams {
+    /** Model name to use */
+    modelName: string;
+    /** Holds any additional parameters that are valid to pass to {@link
+     * https://platform.openai.com/docs/api-reference/completions/create |
+     * `openai.createCompletion`} that are not explicitly specified on this class.
+     */
+    modelKwargs?: Kwargs;
+    /** Batch size to use when passing multiple documents to generate */
+    batchSize: number;
+    /** Maximum number of retries to make when generating */
+    maxRetries: number;
+    /** List of stop words to use when generating */
+    stop?: string[];
+}
 type Kwargs = Record<string, any>;
-export declare class OpenAI extends BaseLLM implements ModelParams {
+/**
+ * Wrapper around OpenAI large language models.
+ *
+ * To use you should have the `openai` package installed, with the
+ * `OPENAI_API_KEY` environment variable set.
+ *
+ * @remarks
+ * Any parameters that are valid to be passed to {@link
+ * https://platform.openai.com/docs/api-reference/completions/create |
+ * `openai.createCompletion`} can be passed through {@link modelKwargs}, even
+ * if not explicitly available on this class.
+ *
+ * @augments BaseLLM
+ * @augments OpenAIInput
+ */
+export declare class OpenAI extends BaseLLM implements OpenAIInput {
     temperature: number;
     maxTokens: number;
     topP: number;
@@ -26,17 +71,18 @@ export declare class OpenAI extends BaseLLM implements ModelParams {
     maxRetries: number;
     stop?: string[];
     private client;
-    constructor(fields?: Partial<ModelParams> & {
+    constructor(fields?: Partial<OpenAIInput> & {
         callbackManager?: LLMCallbackManager;
         verbose?: boolean;
-        modelName?: string;
-        modelKwargs?: Kwargs;
         openAIApiKey?: string;
-        batchSize?: number;
-        maxRetries?: number;
-        stop?: string[];
     });
+    /**
+     * Get the parameters used to invoke the model
+     */
     invocationParams(): CreateCompletionRequest & Kwargs;
+    /**
+     * Get the identifyin parameters for the model
+     */
     identifyingParams(): {
         model: string;
         prompt?: import("openai").CreateCompletionRequestPrompt | null | undefined;
@@ -56,7 +102,23 @@ export declare class OpenAI extends BaseLLM implements ModelParams {
         user?: string | undefined;
         model_name: string;
     };
+    /**
+     * Call out to OpenAI's endpoint with k unique prompts
+     *
+     * @param prompts - The prompts to pass into the model.
+     * @param [stop] - Optional list of stop words to use when generating.
+     *
+     * @returns The full LLM output.
+     *
+     * @example
+     * ```ts
+     * import { OpenAI } from "langchain/llms";
+     * const openai = new OpenAI();
+     * const response = await openai.generate(["Tell me a joke."]);
+     * ```
+     */
     _generate(prompts: string[], stop?: string[]): Promise<LLMResult>;
+    /** @ignore */
     completionWithRetry(request: CreateCompletionRequest): Promise<import("axios").AxiosResponse<import("openai").CreateCompletionResponse, any>>;
     _llmType(): string;
 }