langchain 0.0.4 → 0.0.5

package/dist/esm/llms/openai.js

@@ -1,30 +1,30 @@
-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());
-    });
-};
 import { backOff } from "exponential-backoff";
+import { chunkArray } from "../util";
 import { BaseLLM } from ".";
 let Configuration = null;
 let OpenAIApi = null;
 try {
-    // eslint-disable-next-line global-require
+    // eslint-disable-next-line global-require,import/no-extraneous-dependencies
     ({ Configuration, OpenAIApi } = require("openai"));
 }
 catch (_a) {
     // ignore error
 }
-const chunkArray = (arr, chunkSize) => arr.reduce((chunks, elem, index) => {
-    const chunkIndex = Math.floor(index / chunkSize);
-    const chunk = chunks[chunkIndex] || [];
-    // eslint-disable-next-line no-param-reassign
-    chunks[chunkIndex] = chunk.concat([elem]);
-    return chunks;
-}, []);
+/**
+ * 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 class OpenAI extends BaseLLM {
     constructor(fields) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
@@ -114,7 +114,7 @@ export class OpenAI extends BaseLLM {
             value: void 0
         });
         if (Configuration === null || OpenAIApi === null) {
-            throw new Error("Please install openai as a dependency with, e.g. `npm install -S openai`");
+            throw new Error("Please install openai as a dependency with, e.g. `npm i openai`");
         }
         this.modelName = (_a = fields === null || fields === void 0 ? void 0 : fields.modelName) !== null && _a !== void 0 ? _a : this.modelName;
         this.modelKwargs = (_b = fields === null || fields === void 0 ? void 0 : fields.modelKwargs) !== null && _b !== void 0 ? _b : {};
@@ -134,54 +134,92 @@ export class OpenAI extends BaseLLM {
         });
         this.client = new OpenAIApi(clientConfig);
     }
+    /**
+     * Get the parameters used to invoke the model
+     */
     invocationParams() {
-        return Object.assign({ model: this.modelName, temperature: this.temperature, max_tokens: this.maxTokens, top_p: this.topP, frequency_penalty: this.frequencyPenalty, presence_penalty: this.presencePenalty, n: this.n, best_of: this.bestOf, logit_bias: this.logitBias, stop: this.stop }, this.modelKwargs);
+        return {
+            model: this.modelName,
+            temperature: this.temperature,
+            max_tokens: this.maxTokens,
+            top_p: this.topP,
+            frequency_penalty: this.frequencyPenalty,
+            presence_penalty: this.presencePenalty,
+            n: this.n,
+            best_of: this.bestOf,
+            logit_bias: this.logitBias,
+            stop: this.stop,
+            ...this.modelKwargs,
+        };
     }
+    /**
+     * Get the identifyin parameters for the model
+     */
     identifyingParams() {
-        return Object.assign({ model_name: this.modelName }, this.invocationParams());
+        return {
+            model_name: this.modelName,
+            ...this.invocationParams(),
+        };
     }
-    _generate(prompts, stop) {
+    /**
+     * 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."]);
+     * ```
+     */
+    async _generate(prompts, stop) {
         var _a, _b, _c, _d;
-        return __awaiter(this, void 0, void 0, function* () {
-            const subPrompts = chunkArray(prompts, this.batchSize);
-            const choices = [];
-            const tokenUsage = {};
-            if (this.stop && stop) {
-                throw new Error("Stop found in input and default params");
+        const subPrompts = chunkArray(prompts, this.batchSize);
+        const choices = [];
+        const tokenUsage = {};
+        if (this.stop && stop) {
+            throw new Error("Stop found in input and default params");
+        }
+        const params = this.invocationParams();
+        params.stop = stop !== null && stop !== void 0 ? stop : params.stop;
+        for (let i = 0; i < subPrompts.length; i += 1) {
+            const { data } = await this.completionWithRetry({
+                ...params,
+                prompt: subPrompts[i],
+            });
+            choices.push(...data.choices);
+            const { completion_tokens: completionTokens, prompt_tokens: promptTokens, total_tokens: totalTokens, } = (_a = data.usage) !== null && _a !== void 0 ? _a : {};
+            if (completionTokens) {
+                tokenUsage.completionTokens =
+                    ((_b = tokenUsage.completionTokens) !== null && _b !== void 0 ? _b : 0) + completionTokens;
             }
-            const params = this.invocationParams();
-            params.stop = stop !== null && stop !== void 0 ? stop : params.stop;
-            for (let i = 0; i < subPrompts.length; i += 1) {
-                const { data } = yield this.completionWithRetry(Object.assign(Object.assign({}, params), { prompt: subPrompts[i] }));
-                choices.push(...data.choices);
-                const { completion_tokens: completionTokens, prompt_tokens: promptTokens, total_tokens: totalTokens, } = (_a = data.usage) !== null && _a !== void 0 ? _a : {};
-                if (completionTokens) {
-                    tokenUsage.completionTokens =
-                        ((_b = tokenUsage.completionTokens) !== null && _b !== void 0 ? _b : 0) + completionTokens;
-                }
-                if (promptTokens) {
-                    tokenUsage.promptTokens = ((_c = tokenUsage.promptTokens) !== null && _c !== void 0 ? _c : 0) + promptTokens;
-                }
-                if (totalTokens) {
-                    tokenUsage.totalTokens = ((_d = tokenUsage.totalTokens) !== null && _d !== void 0 ? _d : 0) + totalTokens;
-                }
+            if (promptTokens) {
+                tokenUsage.promptTokens = ((_c = tokenUsage.promptTokens) !== null && _c !== void 0 ? _c : 0) + promptTokens;
             }
-            const generations = chunkArray(choices, this.n).map((promptChoices) => promptChoices.map((choice) => {
-                var _a;
-                return ({
-                    text: (_a = choice.text) !== null && _a !== void 0 ? _a : "",
-                    generationInfo: {
-                        finishReason: choice.finish_reason,
-                        logprobs: choice.logprobs,
-                    },
-                });
-            }));
-            return {
-                generations,
-                llmOutput: { tokenUsage },
-            };
-        });
+            if (totalTokens) {
+                tokenUsage.totalTokens = ((_d = tokenUsage.totalTokens) !== null && _d !== void 0 ? _d : 0) + totalTokens;
+            }
+        }
+        const generations = chunkArray(choices, this.n).map((promptChoices) => promptChoices.map((choice) => {
+            var _a;
+            return ({
+                text: (_a = choice.text) !== null && _a !== void 0 ? _a : "",
+                generationInfo: {
+                    finishReason: choice.finish_reason,
+                    logprobs: choice.logprobs,
+                },
+            });
+        }));
+        return {
+            generations,
+            llmOutput: { tokenUsage },
+        };
     }
+    /** @ignore */
     completionWithRetry(request) {
         const makeCompletionRequest = () => this.client.createCompletion(request);
         return backOff(makeCompletionRequest, {

package/dist/esm/llms/openai.js.map

@@ -1 +1 @@
-{"version":3,"file":"openai.js","sourceRoot":"","sources":["../../../llms/openai.ts"],"names":[],"mappings":";;;;;;;;;AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAiC,MAAM,GAAG,CAAC;AAE3D,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;AAsBD,MAAM,UAAU,GAAG,CAAI,GAAQ,EAAE,SAAiB,EAAE,EAAE,CACpD,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE;IACjC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;IACvC,6CAA6C;IAC7C,MAAM,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,OAAO,MAAM,CAAC;AAChB,CAAC,EAAE,EAAW,CAAC,CAAC;AAElB,MAAM,OAAO,MAAO,SAAQ,OAAO;IA6BjC,YACE,MASC;;QAED,KAAK,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,CAAC,CAAC;QAxClD;;;;mBAAc,GAAG;WAAC;QAElB;;;;mBAAY,GAAG;WAAC;QAEhB;;;;mBAAO,CAAC;WAAC;QAET;;;;mBAAmB,CAAC;WAAC;QAErB;;;;mBAAkB,CAAC;WAAC;QAEpB;;;;mBAAI,CAAC;WAAC;QAEN;;;;mBAAS,CAAC;WAAC;QAEX;;;;;WAAmC;QAEnC;;;;mBAAY,kBAAkB;WAAC;QAE/B;;;;;WAAqB;QAErB;;;;mBAAY,EAAE;WAAC;QAEf;;;;mBAAa,CAAC;WAAC;QAEf;;;;;WAAgB;QAEhB;;;;;WAA2B;QAezB,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,WAAW,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,mCAAI,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,mCAAI,IAAI,CAAC,UAAU,CAAC;QAExD,IAAI,CAAC,WAAW,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,mCAAI,IAAI,CAAC,WAAW,CAAC;QAC3D,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,IAAI,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,IAAI,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCAAI,IAAI,CAAC,gBAAgB,CAAC;QAC1E,IAAI,CAAC,eAAe,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,mCAAI,IAAI,CAAC,eAAe,CAAC;QACvE,IAAI,CAAC,CAAC,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,mCAAI,IAAI,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,mCAAI,IAAI,CAAC,MAAM,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC;QAEzB,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,gBAAgB;QACd,uBACE,KAAK,EAAE,IAAI,CAAC,SAAS,EACrB,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,UAAU,EAAE,IAAI,CAAC,SAAS,EAC1B,KAAK,EAAE,IAAI,CAAC,IAAI,EAChB,iBAAiB,EAAE,IAAI,CAAC,gBAAgB,EACxC,gBAAgB,EAAE,IAAI,CAAC,eAAe,EACtC,CAAC,EAAE,IAAI,CAAC,CAAC,EACT,OAAO,EAAE,IAAI,CAAC,MAAM,EACpB,UAAU,EAAE,IAAI,CAAC,SAAS,EAC1B,IAAI,EAAE,IAAI,CAAC,IAAI,IACZ,IAAI,CAAC,WAAW,EACnB;IACJ,CAAC;IAED,iBAAiB;QACf,uBACE,UAAU,EAAE,IAAI,CAAC,SAAS,IACvB,IAAI,CAAC,gBAAgB,EAAE,EAC1B;IACJ,CAAC;IAEK,SAAS,CAAC,OAAiB,EAAE,IAAe;;;YAChD,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACvD,MAAM,OAAO,GAA2C,EAAE,CAAC;YAC3D,MAAM,UAAU,GAAe,EAAE,CAAC;YAElC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE;gBACrB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC3D;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,IAAI,CAAC;YAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;gBAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,iCAC1C,MAAM,KACT,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,IACrB,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC9B,MAAM,EACJ,iBAAiB,EAAE,gBAAgB,EACnC,aAAa,EAAE,YAAY,EAC3B,YAAY,EAAE,WAAW,GAC1B,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC;gBAErB,IAAI,gBAAgB,EAAE;oBACpB,UAAU,CAAC,gBAAgB;wBACzB,CAAC,MAAA,UAAU,CAAC,gBAAgB,mCAAI,CAAC,CAAC,GAAG,gBAAgB,CAAC;iBACzD;gBAED,IAAI,YAAY,EAAE;oBAChB,UAAU,CAAC,YAAY,GAAG,CAAC,MAAA,UAAU,CAAC,YAAY,mCAAI,CAAC,CAAC,GAAG,YAAY,CAAC;iBACzE;gBAED,IAAI,WAAW,EAAE;oBACf,UAAU,CAAC,WAAW,GAAG,CAAC,MAAA,UAAU,CAAC,WAAW,mCAAI,CAAC,CAAC,GAAG,WAAW,CAAC;iBACtE;aACF;YAED,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CACpE,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;;gBAAC,OAAA,CAAC;oBAC7B,IAAI,EAAE,MAAA,MAAM,CAAC,IAAI,mCAAI,EAAE;oBACvB,cAAc,EAAE;wBACd,YAAY,EAAE,MAAM,CAAC,aAAa;wBAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ;qBAC1B;iBACF,CAAC,CAAA;aAAA,CAAC,CACJ,CAAC;YACF,OAAO;gBACL,WAAW;gBACX,SAAS,EAAE,EAAE,UAAU,EAAE;aAC1B,CAAC;;KACH;IAED,mBAAmB,CAAC,OAAgC;QAClD,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1E,OAAO,OAAO,CAAC,qBAAqB,EAAE;YACpC,aAAa,EAAE,CAAC;YAChB,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,IAAI,CAAC,UAAU;YAC9B,8DAA8D;SAC/D,CAAC,CAAC;IACL,CAAC;IAED,QAAQ;QACN,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
+{"version":3,"file":"openai.js","sourceRoot":"","sources":["../../../llms/openai.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAiC,MAAM,GAAG,CAAC;AAE3D,IAAI,aAAa,GAAiC,IAAI,CAAC;AACvD,IAAI,SAAS,GAA6B,IAAI,CAAC;AAE/C,IAAI;IACF,4EAA4E;IAC5E,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;CACpD;AAAC,WAAM;IACN,eAAe;CAChB;AAgED;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,MAAO,SAAQ,OAAO;IA6BjC,YACE,MAIC;;QAED,KAAK,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,CAAC,CAAC;QAnClD;;;;mBAAc,GAAG;WAAC;QAElB;;;;mBAAY,GAAG;WAAC;QAEhB;;;;mBAAO,CAAC;WAAC;QAET;;;;mBAAmB,CAAC;WAAC;QAErB;;;;mBAAkB,CAAC;WAAC;QAEpB;;;;mBAAI,CAAC;WAAC;QAEN;;;;mBAAS,CAAC;WAAC;QAEX;;;;;WAAmC;QAEnC;;;;mBAAY,kBAAkB;WAAC;QAE/B;;;;;WAAqB;QAErB;;;;mBAAY,EAAE;WAAC;QAEf;;;;mBAAa,CAAC;WAAC;QAEf;;;;;WAAgB;QAEhB;;;;;WAA2B;QAUzB,IAAI,aAAa,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,EAAE;YAChD,MAAM,IAAI,KAAK,CACb,iEAAiE,CAClE,CAAC;SACH;QAED,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,WAAW,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,mCAAI,EAAE,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,mCAAI,IAAI,CAAC,UAAU,CAAC;QAExD,IAAI,CAAC,WAAW,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,mCAAI,IAAI,CAAC,WAAW,CAAC;QAC3D,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;QACrD,IAAI,CAAC,IAAI,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,IAAI,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCAAI,IAAI,CAAC,gBAAgB,CAAC;QAC1E,IAAI,CAAC,eAAe,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,mCAAI,IAAI,CAAC,eAAe,CAAC;QACvE,IAAI,CAAC,CAAC,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,CAAC,mCAAI,IAAI,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,mCAAI,IAAI,CAAC,MAAM,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC;QAEzB,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;;OAEG;IACH,gBAAgB;QACd,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,SAAS;YACrB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,SAAS;YAC1B,KAAK,EAAE,IAAI,CAAC,IAAI;YAChB,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,gBAAgB,EAAE,IAAI,CAAC,eAAe;YACtC,CAAC,EAAE,IAAI,CAAC,CAAC;YACT,OAAO,EAAE,IAAI,CAAC,MAAM;YACpB,UAAU,EAAE,IAAI,CAAC,SAAS;YAC1B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,IAAI,CAAC,WAAW;SACpB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,SAAS;YAC1B,GAAG,IAAI,CAAC,gBAAgB,EAAE;SAC3B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,SAAS,CAAC,OAAiB,EAAE,IAAe;;QAChD,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACvD,MAAM,OAAO,GAA2C,EAAE,CAAC;QAC3D,MAAM,UAAU,GAAe,EAAE,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;SAC3D;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACvC,MAAM,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,IAAI,CAAC;QAElC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;gBAC9C,GAAG,MAAM;gBACT,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;aACtB,CAAC,CAAC;YACH,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,MAAM,EACJ,iBAAiB,EAAE,gBAAgB,EACnC,aAAa,EAAE,YAAY,EAC3B,YAAY,EAAE,WAAW,GAC1B,GAAG,MAAA,IAAI,CAAC,KAAK,mCAAI,EAAE,CAAC;YAErB,IAAI,gBAAgB,EAAE;gBACpB,UAAU,CAAC,gBAAgB;oBACzB,CAAC,MAAA,UAAU,CAAC,gBAAgB,mCAAI,CAAC,CAAC,GAAG,gBAAgB,CAAC;aACzD;YAED,IAAI,YAAY,EAAE;gBAChB,UAAU,CAAC,YAAY,GAAG,CAAC,MAAA,UAAU,CAAC,YAAY,mCAAI,CAAC,CAAC,GAAG,YAAY,CAAC;aACzE;YAED,IAAI,WAAW,EAAE;gBACf,UAAU,CAAC,WAAW,GAAG,CAAC,MAAA,UAAU,CAAC,WAAW,mCAAI,CAAC,CAAC,GAAG,WAAW,CAAC;aACtE;SACF;QAED,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CACpE,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;;YAAC,OAAA,CAAC;gBAC7B,IAAI,EAAE,MAAA,MAAM,CAAC,IAAI,mCAAI,EAAE;gBACvB,cAAc,EAAE;oBACd,YAAY,EAAE,MAAM,CAAC,aAAa;oBAClC,QAAQ,EAAE,MAAM,CAAC,QAAQ;iBAC1B;aACF,CAAC,CAAA;SAAA,CAAC,CACJ,CAAC;QACF,OAAO;YACL,WAAW;YACX,SAAS,EAAE,EAAE,UAAU,EAAE;SAC1B,CAAC;IACJ,CAAC;IAED,cAAc;IACd,mBAAmB,CAAC,OAAgC;QAClD,MAAM,qBAAqB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1E,OAAO,OAAO,CAAC,qBAAqB,EAAE;YACpC,aAAa,EAAE,CAAC;YAChB,QAAQ,EAAE,EAAE;YACZ,aAAa,EAAE,IAAI,CAAC,UAAU;YAC9B,8DAA8D;SAC/D,CAAC,CAAC;IACL,CAAC;IAED,QAAQ;QACN,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/dist/esm/llms/tests/openai.test.js

@@ -1,17 +1,8 @@
-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());
-    });
-};
 import { test } from "@jest/globals";
 import { OpenAI } from "../openai";
-test("Test OpenAI", () => __awaiter(void 0, void 0, void 0, function* () {
+test("Test OpenAI", async () => {
     const model = new OpenAI({ maxTokens: 5 });
-    const res = yield model.call("Print hello world");
+    const res = await model.call("Print hello world");
     console.log({ res });
-}));
+});
 //# sourceMappingURL=openai.test.js.map

package/dist/esm/llms/tests/openai.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"openai.test.js","sourceRoot":"","sources":["../../../../llms/tests/openai.test.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,IAAI,CAAC,aAAa,EAAE,GAAS,EAAE;IAC7B,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;AACvB,CAAC,CAAA,CAAC,CAAC"}
+{"version":3,"file":"openai.test.js","sourceRoot":"","sources":["../../../../llms/tests/openai.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;IAC7B,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}

package/dist/esm/memory/base.d.ts

@@ -0,0 +1,7 @@
+export type InputValues = Record<string, any>;
+export type OutputValues = Record<string, any>;
+export type MemoryVariables = Record<string, any>;
+export declare abstract class BaseMemory {
+    abstract loadMemoryVariables(values: InputValues): Promise<MemoryVariables>;
+    abstract saveContext(inputValues: InputValues, OutputValues: Promise<OutputValues>): Promise<void>;
+}

package/dist/esm/memory/base.js

@@ -0,0 +1,3 @@
+export class BaseMemory {
+}
+//# sourceMappingURL=base.js.map

package/dist/esm/memory/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../memory/base.ts"],"names":[],"mappings":"AAOA,MAAM,OAAgB,UAAU;CAO/B"}

package/dist/esm/memory/buffer_memory.d.ts

@@ -0,0 +1,15 @@
+import { BaseMemory, InputValues, MemoryVariables, OutputValues } from "./base";
+export interface BufferMemoryInput {
+    humanPrefix: string;
+    aiPrefix: string;
+    memoryKey: string;
+}
+export declare class BufferMemory extends BaseMemory implements BufferMemoryInput {
+    humanPrefix: string;
+    aiPrefix: string;
+    memoryKey: string;
+    buffer: string;
+    constructor(fields?: Partial<BufferMemoryInput>);
+    loadMemoryVariables(_values: InputValues): Promise<MemoryVariables>;
+    saveContext(inputValues: InputValues, outputValues: Promise<OutputValues>): Promise<void>;
+}

package/dist/esm/memory/buffer_memory.js

@@ -0,0 +1,53 @@
+import { BaseMemory } from "./base";
+const getInputValue = (inputValues) => {
+    const keys = Object.keys(inputValues);
+    if (keys.length === 1) {
+        return inputValues[keys[0]];
+    }
+    throw new Error("input values have multiple keys, memory only supported when one key currently");
+};
+export class BufferMemory extends BaseMemory {
+    constructor(fields) {
+        var _a, _b, _c;
+        super();
+        Object.defineProperty(this, "humanPrefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "Human"
+        });
+        Object.defineProperty(this, "aiPrefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "AI"
+        });
+        Object.defineProperty(this, "memoryKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "history"
+        });
+        Object.defineProperty(this, "buffer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ""
+        });
+        this.humanPrefix = (_a = fields === null || fields === void 0 ? void 0 : fields.humanPrefix) !== null && _a !== void 0 ? _a : this.humanPrefix;
+        this.aiPrefix = (_b = fields === null || fields === void 0 ? void 0 : fields.aiPrefix) !== null && _b !== void 0 ? _b : this.aiPrefix;
+        this.memoryKey = (_c = fields === null || fields === void 0 ? void 0 : fields.memoryKey) !== null && _c !== void 0 ? _c : this.memoryKey;
+    }
+    async loadMemoryVariables(_values) {
+        const result = { [this.memoryKey]: this.buffer };
+        return result;
+    }
+    async saveContext(inputValues, outputValues) {
+        const values = await outputValues;
+        const human = `${this.humanPrefix}: ${getInputValue(inputValues)}`;
+        const ai = `${this.aiPrefix}: ${getInputValue(values)}`;
+        const newlines = [human, ai];
+        this.buffer += `\n${newlines.join("\n")}`;
+    }
+}
+//# sourceMappingURL=buffer_memory.js.map

package/dist/esm/memory/buffer_memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffer_memory.js","sourceRoot":"","sources":["../../../memory/buffer_memory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAA8C,MAAM,QAAQ,CAAC;AAQhF,MAAM,aAAa,GAAG,CAAC,WAAwB,EAAE,EAAE;IACjD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;KAC7B;IACD,MAAM,IAAI,KAAK,CACb,+EAA+E,CAChF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,YAAa,SAAQ,UAAU;IAS1C,YAAY,MAAmC;;QAC7C,KAAK,EAAE,CAAC;QATV;;;;mBAAc,OAAO;WAAC;QAEtB;;;;mBAAW,IAAI;WAAC;QAEhB;;;;mBAAY,SAAS;WAAC;QAEtB;;;;mBAAS,EAAE;WAAC;QAIV,IAAI,CAAC,WAAW,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,mCAAI,IAAI,CAAC,WAAW,CAAC;QAC3D,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,mCAAI,IAAI,CAAC,QAAQ,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,mCAAI,IAAI,CAAC,SAAS,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,OAAoB;QAC5C,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QACjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,WAAW,CACf,WAAwB,EACxB,YAAmC;QAEnC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;QAClC,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,WAAW,KAAK,aAAa,CAAC,WAAW,CAAC,EAAE,CAAC;QACnE,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,QAAQ,KAAK,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,MAAM,QAAQ,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAC5C,CAAC;CACF"}

package/dist/esm/memory/index.d.ts

@@ -0,0 +1,2 @@
+export { BufferMemory } from "./buffer_memory";
+export { BaseMemory } from "./base";

package/dist/esm/memory/index.js

@@ -0,0 +1,3 @@
+export { BufferMemory } from "./buffer_memory";
+export { BaseMemory } from "./base";
+//# sourceMappingURL=index.js.map

package/dist/esm/memory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../memory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC"}

package/dist/esm/memory/tests/buffer_memory.test.d.ts

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

package/dist/esm/memory/tests/buffer_memory.test.js

@@ -0,0 +1,15 @@
+import { test, expect } from "@jest/globals";
+import { BufferMemory } from "../buffer_memory";
+test("Test buffer memory", async () => {
+    const memory = new BufferMemory();
+    const result1 = await memory.loadMemoryVariables({});
+    expect(result1).toStrictEqual({ history: "" });
+    const result = new Promise((resolve, _reject) => {
+        resolve({ bar: "foo" });
+    });
+    await memory.saveContext({ foo: "bar" }, result);
+    const expectedString = "\nHuman: bar\nAI: foo";
+    const result2 = await memory.loadMemoryVariables({});
+    expect(result2).toStrictEqual({ history: expectedString });
+});
+//# sourceMappingURL=buffer_memory.test.js.map

package/dist/esm/memory/tests/buffer_memory.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffer_memory.test.js","sourceRoot":"","sources":["../../../../memory/tests/buffer_memory.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;IACpC,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAE/C,MAAM,MAAM,GAAG,IAAI,OAAO,CAAe,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;QAC5D,OAAO,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC;IACjD,MAAM,cAAc,GAAG,uBAAuB,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;AAC7D,CAAC,CAAC,CAAC"}

package/dist/esm/prompt/base.d.ts

@@ -3,17 +3,56 @@ import { PromptTemplate, FewShotPromptTemplate } from "./index";
 declare const templateClasses: (typeof PromptTemplate | typeof FewShotPromptTemplate)[];
 export type SerializedBasePromptTemplate = ReturnType<InstanceType<(typeof templateClasses)[number]>["serialize"]>;
 export type InputValues = Record<string, any>;
+/**
+ * Input common to all prompt templates.
+ */
 export interface BasePromptTemplateInput {
+    /**
+     * A list of variable names the prompt template expects
+     */
     inputVariables: string[];
+    /**
+     * How to parse the output of calling an LLM on this formatted prompt
+     */
     outputParser?: BaseOutputParser;
 }
+/**
+ * Base class for prompt templates. Exposes a format method that returns a
+ * string prompt given a set of input values.
+ * @augments BasePromptTemplateInput
+ */
 export declare abstract class BasePromptTemplate implements BasePromptTemplateInput {
     inputVariables: string[];
     outputParser?: BaseOutputParser;
     constructor(input: BasePromptTemplateInput);
+    /**
+     * Format the prompt given the input values.
+     *
+     * @param inputValues - A dictionary of arguments to be passed to the prompt template.
+     * @returns A formatted prompt string.
+     *
+     * @example
+     * ```ts
+     * prompt.format({ foo: "bar" });
+     * ```
+     */
     abstract format(values: InputValues): string;
+    /**
+     * Return the string type key uniquely identifying this class of prompt template.
+     */
     abstract _getPromptType(): string;
+    /**
+     * Return a json-like object representing this prompt template.
+     */
     abstract serialize(): SerializedBasePromptTemplate;
+    /**
+     * Load a prompt template from a json-like object describing it.
+     *
+     * @remarks
+     * Deserializing needs to be async because templates (e.g. {@link FewShotPromptTemplate}) can
+     * reference remote resources that we read asynchronously with a web
+     * request.
+     */
     static deserialize(data: SerializedBasePromptTemplate): Promise<BasePromptTemplate>;
 }
 export {};

package/dist/esm/prompt/base.js

@@ -1,14 +1,10 @@
-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());
-    });
-};
 import { PromptTemplate, FewShotPromptTemplate } from "./index";
 const templateClasses = [PromptTemplate, FewShotPromptTemplate];
+/**
+ * Base class for prompt templates. Exposes a format method that returns a
+ * string prompt given a set of input values.
+ * @augments BasePromptTemplateInput
+ */
 export class BasePromptTemplate {
     constructor(input) {
         Object.defineProperty(this, "inputVariables", {
@@ -29,22 +25,25 @@ export class BasePromptTemplate {
         }
         Object.assign(this, input);
     }
-    // Deserializing needs to be async because templates (e.g. few_shot) can
-    // reference remote resources that we read asynchronously with a web
-    // request.
-    static deserialize(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            switch (data._type) {
-                case "prompt":
-                    return PromptTemplate.deserialize(data);
-                case undefined:
-                    return PromptTemplate.deserialize(Object.assign(Object.assign({}, data), { _type: "prompt" }));
-                case "few_shot":
-                    return FewShotPromptTemplate.deserialize(data);
-                default:
-                    throw new Error(`Invalid prompt type in config: ${data._type}`);
-            }
-        });
+    /**
+     * Load a prompt template from a json-like object describing it.
+     *
+     * @remarks
+     * Deserializing needs to be async because templates (e.g. {@link FewShotPromptTemplate}) can
+     * reference remote resources that we read asynchronously with a web
+     * request.
+     */
+    static async deserialize(data) {
+        switch (data._type) {
+            case "prompt":
+                return PromptTemplate.deserialize(data);
+            case undefined:
+                return PromptTemplate.deserialize({ ...data, _type: "prompt" });
+            case "few_shot":
+                return FewShotPromptTemplate.deserialize(data);
+            default:
+                throw new Error(`Invalid prompt type in config: ${data._type}`);
+        }
     }
 }
 //# sourceMappingURL=base.js.map

package/dist/esm/prompt/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../prompt/base.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,eAAe,GAAG,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAC;AAchE,MAAM,OAAgB,kBAAkB;IAKtC,YAAY,KAA8B;QAJ1C;;;;;WAAyB;QAEzB;;;;;WAAgC;QAG9B,MAAM,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;QACjC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;SACH;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAQD,wEAAwE;IACxE,oEAAoE;IACpE,WAAW;IACX,MAAM,CAAO,WAAW,CACtB,IAAkC;;YAElC,QAAQ,IAAI,CAAC,KAAK,EAAE;gBAClB,KAAK,QAAQ;oBACX,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC1C,KAAK,SAAS;oBACZ,OAAO,cAAc,CAAC,WAAW,iCAAM,IAAI,KAAE,KAAK,EAAE,QAAQ,IAAG,CAAC;gBAClE,KAAK,UAAU;oBACb,OAAO,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACjD;oBACE,MAAM,IAAI,KAAK,CACb,kCACG,IAAqC,CAAC,KACzC,EAAE,CACH,CAAC;aACL;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../prompt/base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAEhE,MAAM,eAAe,GAAG,CAAC,cAAc,EAAE,qBAAqB,CAAC,CAAC;AAwBhE;;;;GAIG;AACH,MAAM,OAAgB,kBAAkB;IAKtC,YAAY,KAA8B;QAJ1C;;;;;WAAyB;QAEzB;;;;;WAAgC;QAG9B,MAAM,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;QACjC,IAAI,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;SACH;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAyBD;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,WAAW,CACtB,IAAkC;QAElC,QAAQ,IAAI,CAAC,KAAK,EAAE;YAClB,KAAK,QAAQ;gBACX,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAC1C,KAAK,SAAS;gBACZ,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;YAClE,KAAK,UAAU;gBACb,OAAO,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACjD;gBACE,MAAM,IAAI,KAAK,CACb,kCACG,IAAqC,CAAC,KACzC,EAAE,CACH,CAAC;SACL;IACH,CAAC;CACF"}

package/dist/esm/prompt/few_shot.d.ts

@@ -19,15 +19,50 @@ export type SerializedFewShotTemplate = {
     template_format: TemplateFormat;
 };
 export interface FewShotPromptTemplateInput extends BasePromptTemplateInput {
+    /**
+     * Examples to format into the prompt. Exactly one of this or
+     * {@link exampleSelector} must be
+     * provided.
+     */
     examples?: Example[];
-    examplePrompt: PromptTemplate;
+    /**
+     * An {@link ExampleSelector} Examples to format into the prompt. Exactly one of this or
+     * {@link examples} must be
+     * provided.
+     */
     exampleSelector?: ExampleSelector;
+    /**
+     * An {@link PromptTemplate} used to format a single example.
+     */
+    examplePrompt: PromptTemplate;
+    /**
+     * String separator used to join the prefix, the examples, and suffix.
+     */
     exampleSeparator: string;
+    /**
+     * A prompt template string to put before the examples.
+     *
+     * @defaultValue `""`
+     */
     prefix: string;
+    /**
+     * A prompt template string to put after the examples.
+     */
     suffix: string;
+    /**
+     * The format of the prompt template. Options are: 'f-string', 'jinja-2'
+     */
     templateFormat: TemplateFormat;
+    /**
+     * Whether or not to try validating the template on initialization.
+     */
     validateTemplate?: boolean;
 }
+/**
+ * Prompt template that contains few-shot examples.
+ * @augments BasePromptTemplate
+ * @augments FewShotPromptTemplateInput
+ */
 export declare class FewShotPromptTemplate extends BasePromptTemplate implements FewShotPromptTemplateInput {
     examples?: InputValues[];
     exampleSelector?: ExampleSelector;

package/dist/esm/prompt/few_shot.js

@@ -1,17 +1,13 @@
-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());
-    });
-};
 import { BasePromptTemplate, } from "./index";
 import { checkValidTemplate, renderTemplate } from "./template";
 import { resolveTemplateFromFile, resolveConfigFromFile, parseFileConfig, } from "../util";
 import { PromptTemplate } from "./prompt";
 import { BaseOutputParser } from "./parser";
+/**
+ * Prompt template that contains few-shot examples.
+ * @augments BasePromptTemplate
+ * @augments FewShotPromptTemplateInput
+ */
 export class FewShotPromptTemplate extends BasePromptTemplate {
     constructor(input) {
         super(input);
@@ -109,30 +105,28 @@ export class FewShotPromptTemplate extends BasePromptTemplate {
             examples: this.examples,
         };
     }
-    static deserialize(data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const serializedPrompt = resolveConfigFromFile("example_prompt", data);
-            const examplePrompt = yield PromptTemplate.deserialize(serializedPrompt);
-            let examples;
-            if (typeof data.examples === "string") {
-                examples = parseFileConfig(data.examples, [".json", ".yml", ".yaml"]);
-            }
-            else if (Array.isArray(data.examples)) {
-                examples = data.examples;
-            }
-            else {
-                throw new Error("Invalid examples format. Only list or string are supported.");
-            }
-            return new FewShotPromptTemplate({
-                inputVariables: data.input_variables,
-                outputParser: data.output_parser && BaseOutputParser.deserialize(data.output_parser),
-                examplePrompt,
-                examples,
-                exampleSeparator: data.example_separator,
-                prefix: resolveTemplateFromFile("prefix", data),
-                suffix: resolveTemplateFromFile("suffix", data),
-                templateFormat: data.template_format,
-            });
+    static async deserialize(data) {
+        const serializedPrompt = resolveConfigFromFile("example_prompt", data);
+        const examplePrompt = await PromptTemplate.deserialize(serializedPrompt);
+        let examples;
+        if (typeof data.examples === "string") {
+            examples = parseFileConfig(data.examples, [".json", ".yml", ".yaml"]);
+        }
+        else if (Array.isArray(data.examples)) {
+            examples = data.examples;
+        }
+        else {
+            throw new Error("Invalid examples format. Only list or string are supported.");
+        }
+        return new FewShotPromptTemplate({
+            inputVariables: data.input_variables,
+            outputParser: data.output_parser && BaseOutputParser.deserialize(data.output_parser),
+            examplePrompt,
+            examples,
+            exampleSeparator: data.example_separator,
+            prefix: resolveTemplateFromFile("prefix", data),
+            suffix: resolveTemplateFromFile("suffix", data),
+            templateFormat: data.template_format,
         });
     }
 }