langchain 0.0.130 → 0.0.132

package/dist/embeddings/tensorflow.cjs

@@ -27,6 +27,11 @@ exports.TensorFlowEmbeddings = void 0;
 const universal_sentence_encoder_1 = require("@tensorflow-models/universal-sentence-encoder");
 const tf = __importStar(require("@tensorflow/tfjs-core"));
 const base_js_1 = require("./base.cjs");
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Universal Sentence Encoder model from
+ * TensorFlow.js.
+ */
 class TensorFlowEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -43,6 +48,12 @@ class TensorFlowEmbeddings extends base_js_1.Embeddings {
             throw new Error("No TensorFlow backend found, see instructions at ...");
         }
     }
+    /**
+     * Private method that loads the Universal Sentence Encoder model if it
+     * hasn't been loaded already. It returns a promise that resolves to the
+     * loaded model.
+     * @returns Promise that resolves to the loaded Universal Sentence Encoder model.
+     */
     async load() {
         if (this._cached === undefined) {
             this._cached = (0, universal_sentence_encoder_1.load)();
@@ -55,11 +66,27 @@ class TensorFlowEmbeddings extends base_js_1.Embeddings {
             return model.embed(texts);
         });
     }
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embed method
+     * with the document as the input and processes the result to return a
+     * single embedding.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document) {
         return this._embed([document])
             .then((embeddings) => embeddings.array())
             .then((embeddings) => embeddings[0]);
     }
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embed method with the documents as the input and processes the
+     * result to return the embeddings.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents) {
         return this._embed(documents).then((embeddings) => embeddings.array());
     }

package/dist/embeddings/tensorflow.d.ts

@@ -1,12 +1,43 @@
 import { load } from "@tensorflow-models/universal-sentence-encoder";
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the TensorFlowEmbeddings class.
+ */
 export interface TensorFlowEmbeddingsParams extends EmbeddingsParams {
 }
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Universal Sentence Encoder model from
+ * TensorFlow.js.
+ */
 export declare class TensorFlowEmbeddings extends Embeddings {
     constructor(fields?: TensorFlowEmbeddingsParams);
     _cached: ReturnType<typeof load>;
+    /**
+     * Private method that loads the Universal Sentence Encoder model if it
+     * hasn't been loaded already. It returns a promise that resolves to the
+     * loaded model.
+     * @returns Promise that resolves to the loaded Universal Sentence Encoder model.
+     */
     private load;
     private _embed;
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embed method
+     * with the document as the input and processes the result to return a
+     * single embedding.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document: string): Promise<number[]>;
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embed method with the documents as the input and processes the
+     * result to return the embeddings.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
 }

package/dist/embeddings/tensorflow.js

@@ -1,6 +1,11 @@
 import { load } from "@tensorflow-models/universal-sentence-encoder";
 import * as tf from "@tensorflow/tfjs-core";
 import { Embeddings } from "./base.js";
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Universal Sentence Encoder model from
+ * TensorFlow.js.
+ */
 export class TensorFlowEmbeddings extends Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -17,6 +22,12 @@ export class TensorFlowEmbeddings extends Embeddings {
             throw new Error("No TensorFlow backend found, see instructions at ...");
         }
     }
+    /**
+     * Private method that loads the Universal Sentence Encoder model if it
+     * hasn't been loaded already. It returns a promise that resolves to the
+     * loaded model.
+     * @returns Promise that resolves to the loaded Universal Sentence Encoder model.
+     */
     async load() {
         if (this._cached === undefined) {
             this._cached = load();
@@ -29,11 +40,27 @@ export class TensorFlowEmbeddings extends Embeddings {
             return model.embed(texts);
         });
     }
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embed method
+     * with the document as the input and processes the result to return a
+     * single embedding.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document) {
         return this._embed([document])
             .then((embeddings) => embeddings.array())
             .then((embeddings) => embeddings[0]);
     }
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embed method with the documents as the input and processes the
+     * result to return the embeddings.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents) {
         return this._embed(documents).then((embeddings) => embeddings.array());
     }

package/dist/evaluation/qa/eval_chain.cjs

@@ -5,6 +5,9 @@ const prompt_js_1 = require("./prompt.cjs");
 const llm_chain_js_1 = require("../../chains/llm_chain.cjs");
 const eqSet = (xs, ys) => xs.size === ys.size && [...xs].every((x) => ys.has(x));
 class QAEvalChain extends llm_chain_js_1.LLMChain {
+    static lc_name() {
+        return "QAEvalChain";
+    }
     static fromLlm(llm, options = {}) {
         const prompt = options.prompt || prompt_js_1.QA_PROMPT;
         const expectedInputVars = new Set([

package/dist/evaluation/qa/eval_chain.d.ts

@@ -8,6 +8,7 @@ export interface EvaluateArgs {
     predictionKey: string;
 }
 export declare class QAEvalChain extends LLMChain {
+    static lc_name(): string;
     static fromLlm(llm: BaseLanguageModel, options?: {
         prompt?: PromptTemplate;
         chainInput?: Omit<LLMChainInput, "llm">;

package/dist/evaluation/qa/eval_chain.js

@@ -2,6 +2,9 @@ import { QA_PROMPT } from "./prompt.js";
 import { LLMChain } from "../../chains/llm_chain.js";
 const eqSet = (xs, ys) => xs.size === ys.size && [...xs].every((x) => ys.has(x));
 export class QAEvalChain extends LLMChain {
+    static lc_name() {
+        return "QAEvalChain";
+    }
     static fromLlm(llm, options = {}) {
         const prompt = options.prompt || QA_PROMPT;
         const expectedInputVars = new Set([

package/dist/experimental/autogpt/agent.cjs

@@ -9,6 +9,11 @@ const index_js_1 = require("../../schema/index.cjs");
 const schema_js_1 = require("./schema.cjs");
 const text_splitter_js_1 = require("../../text_splitter.cjs");
 const count_tokens_js_1 = require("../../base_language/count_tokens.cjs");
+/**
+ * Class representing the AutoGPT concept with LangChain primitives. It is
+ * designed to be used with a set of tools such as a search tool,
+ * write-file tool, and a read-file tool.
+ */
 class AutoGPT {
     constructor({ aiName, memory, chain, outputParser, tools, feedbackTool, maxIterations, }) {
         Object.defineProperty(this, "aiName", {
@@ -89,6 +94,17 @@ class AutoGPT {
             chunkOverlap: Math.round(chunkSize / 10),
         });
     }
+    /**
+     * Creates a new AutoGPT instance from a given LLM and a set of tools.
+     * @param llm A BaseChatModel object.
+     * @param tools An array of ObjectTool objects.
+     * @param options.aiName The name of the AI.
+     * @param options.aiRole The role of the AI.
+     * @param options.memory A VectorStoreRetriever object that represents the memory of the AI.
+     * @param options.maxIterations The maximum number of iterations the AI can perform.
+     * @param options.outputParser An AutoGPTOutputParser object that parses the output of the AI.
+     * @returns A new instance of the AutoGPT class.
+     */
     static fromLLMAndTools(llm, tools, { aiName, aiRole, memory, maxIterations = 100, 
     // humanInTheLoop = false,
     outputParser = new output_parser_js_1.AutoGPTOutputParser(), }) {
@@ -111,6 +127,11 @@ class AutoGPT {
             maxIterations,
         });
     }
+    /**
+     * Runs the AI with a given set of goals.
+     * @param goals An array of strings representing the goals.
+     * @returns A string representing the result of the run or undefined if the maximum number of iterations is reached without a result.
+     */
     async run(goals) {
         const user_input = "Determine which next command to use, and respond using the format specified above:";
         let loopCount = 0;

package/dist/experimental/autogpt/agent.d.ts

@@ -6,6 +6,9 @@ import { AutoGPTOutputParser } from "./output_parser.js";
 import { BaseMessage } from "../../schema/index.js";
 import { ObjectTool } from "./schema.js";
 import { TokenTextSplitter } from "../../text_splitter.js";
+/**
+ * Interface for the input parameters of the AutoGPT class.
+ */
 export interface AutoGPTInput {
     aiName: string;
     aiRole: string;
@@ -14,6 +17,11 @@ export interface AutoGPTInput {
     outputParser?: AutoGPTOutputParser;
     maxIterations?: number;
 }
+/**
+ * Class representing the AutoGPT concept with LangChain primitives. It is
+ * designed to be used with a set of tools such as a search tool,
+ * write-file tool, and a read-file tool.
+ */
 export declare class AutoGPT {
     aiName: string;
     memory: VectorStoreRetriever;
@@ -30,6 +38,22 @@ export declare class AutoGPT {
         tools: ObjectTool[];
         feedbackTool?: Tool;
     });
+    /**
+     * Creates a new AutoGPT instance from a given LLM and a set of tools.
+     * @param llm A BaseChatModel object.
+     * @param tools An array of ObjectTool objects.
+     * @param options.aiName The name of the AI.
+     * @param options.aiRole The role of the AI.
+     * @param options.memory A VectorStoreRetriever object that represents the memory of the AI.
+     * @param options.maxIterations The maximum number of iterations the AI can perform.
+     * @param options.outputParser An AutoGPTOutputParser object that parses the output of the AI.
+     * @returns A new instance of the AutoGPT class.
+     */
     static fromLLMAndTools(llm: BaseChatModel, tools: ObjectTool[], { aiName, aiRole, memory, maxIterations, outputParser, }: AutoGPTInput): AutoGPT;
+    /**
+     * Runs the AI with a given set of goals.
+     * @param goals An array of strings representing the goals.
+     * @returns A string representing the result of the run or undefined if the maximum number of iterations is reached without a result.
+     */
     run(goals: string[]): Promise<string | undefined>;
 }

package/dist/experimental/autogpt/agent.js

@@ -6,6 +6,11 @@ import { AIMessage, HumanMessage, SystemMessage, } from "../../schema/index.js";
 import { FINISH_NAME } from "./schema.js";
 import { TokenTextSplitter } from "../../text_splitter.js";
 import { getEmbeddingContextSize, getModelContextSize, } from "../../base_language/count_tokens.js";
+/**
+ * Class representing the AutoGPT concept with LangChain primitives. It is
+ * designed to be used with a set of tools such as a search tool,
+ * write-file tool, and a read-file tool.
+ */
 export class AutoGPT {
     constructor({ aiName, memory, chain, outputParser, tools, feedbackTool, maxIterations, }) {
         Object.defineProperty(this, "aiName", {
@@ -86,6 +91,17 @@ export class AutoGPT {
             chunkOverlap: Math.round(chunkSize / 10),
         });
     }
+    /**
+     * Creates a new AutoGPT instance from a given LLM and a set of tools.
+     * @param llm A BaseChatModel object.
+     * @param tools An array of ObjectTool objects.
+     * @param options.aiName The name of the AI.
+     * @param options.aiRole The role of the AI.
+     * @param options.memory A VectorStoreRetriever object that represents the memory of the AI.
+     * @param options.maxIterations The maximum number of iterations the AI can perform.
+     * @param options.outputParser An AutoGPTOutputParser object that parses the output of the AI.
+     * @returns A new instance of the AutoGPT class.
+     */
     static fromLLMAndTools(llm, tools, { aiName, aiRole, memory, maxIterations = 100, 
     // humanInTheLoop = false,
     outputParser = new AutoGPTOutputParser(), }) {
@@ -108,6 +124,11 @@ export class AutoGPT {
             maxIterations,
         });
     }
+    /**
+     * Runs the AI with a given set of goals.
+     * @param goals An array of strings representing the goals.
+     * @returns A string representing the result of the run or undefined if the maximum number of iterations is reached without a result.
+     */
     async run(goals) {
         const user_input = "Determine which next command to use, and respond using the format specified above:";
         let loopCount = 0;

package/dist/experimental/autogpt/output_parser.cjs

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoGPTOutputParser = exports.preprocessJsonInput = void 0;
 const output_parser_js_1 = require("../../schema/output_parser.cjs");
+/**
+ * Utility function used to preprocess a string to be parsed as JSON. It
+ * replaces single backslashes with double backslashes, while leaving
+ * already escaped ones intact.
+ */
 function preprocessJsonInput(inputStr) {
     // Replace single backslashes with double backslashes,
     // while leaving already escaped ones intact
@@ -9,6 +14,10 @@ function preprocessJsonInput(inputStr) {
     return correctedStr;
 }
 exports.preprocessJsonInput = preprocessJsonInput;
+/**
+ * Class responsible for parsing the output of AutoGPT. It extends the
+ * BaseOutputParser class.
+ */
 class AutoGPTOutputParser extends output_parser_js_1.BaseOutputParser {
     constructor() {
         super(...arguments);
@@ -19,9 +28,24 @@ class AutoGPTOutputParser extends output_parser_js_1.BaseOutputParser {
             value: ["langchain", "experimental", "autogpt"]
         });
     }
+    /**
+     * Method not implemented in the class and will throw an error if called.
+     * It is likely meant to be overridden in subclasses to provide specific
+     * format instructions.
+     * @returns Throws an error.
+     */
     getFormatInstructions() {
         throw new Error("Method not implemented.");
     }
+    /**
+     * Asynchronous method that takes a string as input and attempts to parse
+     * it into an AutoGPTAction object. If the input string cannot be parsed
+     * directly, the method tries to preprocess the string using the
+     * preprocessJsonInput function and parse it again. If parsing fails
+     * again, it returns an AutoGPTAction object with an error message.
+     * @param text The string to be parsed.
+     * @returns A Promise that resolves to an AutoGPTAction object.
+     */
     async parse(text) {
         let parsed;
         try {

package/dist/experimental/autogpt/output_parser.d.ts

@@ -1,8 +1,32 @@
 import { BaseOutputParser } from "../../schema/output_parser.js";
 import { AutoGPTAction } from "./schema.js";
+/**
+ * Utility function used to preprocess a string to be parsed as JSON. It
+ * replaces single backslashes with double backslashes, while leaving
+ * already escaped ones intact.
+ */
 export declare function preprocessJsonInput(inputStr: string): string;
+/**
+ * Class responsible for parsing the output of AutoGPT. It extends the
+ * BaseOutputParser class.
+ */
 export declare class AutoGPTOutputParser extends BaseOutputParser<AutoGPTAction> {
     lc_namespace: string[];
+    /**
+     * Method not implemented in the class and will throw an error if called.
+     * It is likely meant to be overridden in subclasses to provide specific
+     * format instructions.
+     * @returns Throws an error.
+     */
     getFormatInstructions(): string;
+    /**
+     * Asynchronous method that takes a string as input and attempts to parse
+     * it into an AutoGPTAction object. If the input string cannot be parsed
+     * directly, the method tries to preprocess the string using the
+     * preprocessJsonInput function and parse it again. If parsing fails
+     * again, it returns an AutoGPTAction object with an error message.
+     * @param text The string to be parsed.
+     * @returns A Promise that resolves to an AutoGPTAction object.
+     */
     parse(text: string): Promise<AutoGPTAction>;
 }

package/dist/experimental/autogpt/output_parser.js

@@ -1,10 +1,19 @@
 import { BaseOutputParser } from "../../schema/output_parser.js";
+/**
+ * Utility function used to preprocess a string to be parsed as JSON. It
+ * replaces single backslashes with double backslashes, while leaving
+ * already escaped ones intact.
+ */
 export function preprocessJsonInput(inputStr) {
     // Replace single backslashes with double backslashes,
     // while leaving already escaped ones intact
     const correctedStr = inputStr.replace(/(?<!\\)\\(?!["\\/bfnrt]|u[0-9a-fA-F]{4})/g, "\\\\");
     return correctedStr;
 }
+/**
+ * Class responsible for parsing the output of AutoGPT. It extends the
+ * BaseOutputParser class.
+ */
 export class AutoGPTOutputParser extends BaseOutputParser {
     constructor() {
         super(...arguments);
@@ -15,9 +24,24 @@ export class AutoGPTOutputParser extends BaseOutputParser {
             value: ["langchain", "experimental", "autogpt"]
         });
     }
+    /**
+     * Method not implemented in the class and will throw an error if called.
+     * It is likely meant to be overridden in subclasses to provide specific
+     * format instructions.
+     * @returns Throws an error.
+     */
     getFormatInstructions() {
         throw new Error("Method not implemented.");
     }
+    /**
+     * Asynchronous method that takes a string as input and attempts to parse
+     * it into an AutoGPTAction object. If the input string cannot be parsed
+     * directly, the method tries to preprocess the string using the
+     * preprocessJsonInput function and parse it again. If parsing fails
+     * again, it returns an AutoGPTAction object with an error message.
+     * @param text The string to be parsed.
+     * @returns A Promise that resolves to an AutoGPTAction object.
+     */
     async parse(text) {
         let parsed;
         try {

package/dist/experimental/autogpt/prompt.cjs

@@ -4,6 +4,12 @@ exports.AutoGPTPrompt = void 0;
 const chat_js_1 = require("../../prompts/chat.cjs");
 const index_js_1 = require("../../schema/index.cjs");
 const prompt_generator_js_1 = require("./prompt_generator.cjs");
+/**
+ * Class used to generate prompts for the AutoGPT model. It takes into
+ * account the AI's name, role, tools, token counter, and send token
+ * limit. The class also handles the formatting of messages and the
+ * construction of the full prompt.
+ */
 class AutoGPTPrompt extends chat_js_1.BaseChatPromptTemplate {
     constructor(fields) {
         super({ inputVariables: ["goals", "memory", "messages", "user_input"] });
@@ -46,6 +52,11 @@ class AutoGPTPrompt extends chat_js_1.BaseChatPromptTemplate {
     _getPromptType() {
         return "autogpt";
     }
+    /**
+     * Constructs the full prompt based on the provided goals.
+     * @param goals An array of goals.
+     * @returns The full prompt as a string.
+     */
     constructFullPrompt(goals) {
         const promptStart = `Your decisions must always be made independently
             without seeking user assistance. Play to your strengths
@@ -59,6 +70,14 @@ class AutoGPTPrompt extends chat_js_1.BaseChatPromptTemplate {
         fullPrompt += `\n\n${(0, prompt_generator_js_1.getPrompt)(this.tools)}`;
         return fullPrompt;
     }
+    /**
+     * Formats the messages based on the provided parameters.
+     * @param goals An array of goals.
+     * @param memory A VectorStoreRetriever instance.
+     * @param messages An array of previous messages.
+     * @param user_input The user's input.
+     * @returns An array of formatted messages.
+     */
     async formatMessages({ goals, memory, messages: previousMessages, user_input, }) {
         const basePrompt = new index_js_1.SystemMessage(this.constructFullPrompt(goals));
         const timePrompt = new index_js_1.SystemMessage(`The current time and date is ${new Date().toLocaleString()}`);
@@ -92,6 +111,12 @@ class AutoGPTPrompt extends chat_js_1.BaseChatPromptTemplate {
         ];
         return messages;
     }
+    /**
+     * This method is not implemented in the AutoGPTPrompt class and will
+     * throw an error if called.
+     * @param _values Partial values.
+     * @returns Throws an error.
+     */
     async partial(_values) {
         throw new Error("Method not implemented.");
     }

package/dist/experimental/autogpt/prompt.d.ts

@@ -3,6 +3,9 @@ import { BaseMessage, PartialValues } from "../../schema/index.js";
 import { VectorStoreRetriever } from "../../vectorstores/base.js";
 import { ObjectTool } from "./schema.js";
 import { SerializedBasePromptTemplate } from "../../prompts/serde.js";
+/**
+ * Interface for the input parameters of the AutoGPTPrompt class.
+ */
 export interface AutoGPTPromptInput {
     aiName: string;
     aiRole: string;
@@ -10,6 +13,12 @@ export interface AutoGPTPromptInput {
     tokenCounter: (text: string) => Promise<number>;
     sendTokenLimit?: number;
 }
+/**
+ * Class used to generate prompts for the AutoGPT model. It takes into
+ * account the AI's name, role, tools, token counter, and send token
+ * limit. The class also handles the formatting of messages and the
+ * construction of the full prompt.
+ */
 export declare class AutoGPTPrompt extends BaseChatPromptTemplate implements AutoGPTPromptInput {
     aiName: string;
     aiRole: string;
@@ -18,13 +27,32 @@ export declare class AutoGPTPrompt extends BaseChatPromptTemplate implements Aut
     sendTokenLimit: number;
     constructor(fields: AutoGPTPromptInput);
     _getPromptType(): "autogpt";
+    /**
+     * Constructs the full prompt based on the provided goals.
+     * @param goals An array of goals.
+     * @returns The full prompt as a string.
+     */
     constructFullPrompt(goals: string[]): string;
+    /**
+     * Formats the messages based on the provided parameters.
+     * @param goals An array of goals.
+     * @param memory A VectorStoreRetriever instance.
+     * @param messages An array of previous messages.
+     * @param user_input The user's input.
+     * @returns An array of formatted messages.
+     */
     formatMessages({ goals, memory, messages: previousMessages, user_input, }: {
         goals: string[];
         memory: VectorStoreRetriever;
         messages: BaseMessage[];
         user_input: string;
     }): Promise<BaseMessage[]>;
+    /**
+     * This method is not implemented in the AutoGPTPrompt class and will
+     * throw an error if called.
+     * @param _values Partial values.
+     * @returns Throws an error.
+     */
     partial(_values: PartialValues): Promise<BaseChatPromptTemplate>;
     serialize(): SerializedBasePromptTemplate;
 }

package/dist/experimental/autogpt/prompt.js

@@ -1,6 +1,12 @@
 import { BaseChatPromptTemplate } from "../../prompts/chat.js";
 import { HumanMessage, SystemMessage, } from "../../schema/index.js";
 import { getPrompt } from "./prompt_generator.js";
+/**
+ * Class used to generate prompts for the AutoGPT model. It takes into
+ * account the AI's name, role, tools, token counter, and send token
+ * limit. The class also handles the formatting of messages and the
+ * construction of the full prompt.
+ */
 export class AutoGPTPrompt extends BaseChatPromptTemplate {
     constructor(fields) {
         super({ inputVariables: ["goals", "memory", "messages", "user_input"] });
@@ -43,6 +49,11 @@ export class AutoGPTPrompt extends BaseChatPromptTemplate {
     _getPromptType() {
         return "autogpt";
     }
+    /**
+     * Constructs the full prompt based on the provided goals.
+     * @param goals An array of goals.
+     * @returns The full prompt as a string.
+     */
     constructFullPrompt(goals) {
         const promptStart = `Your decisions must always be made independently
             without seeking user assistance. Play to your strengths
@@ -56,6 +67,14 @@ export class AutoGPTPrompt extends BaseChatPromptTemplate {
         fullPrompt += `\n\n${getPrompt(this.tools)}`;
         return fullPrompt;
     }
+    /**
+     * Formats the messages based on the provided parameters.
+     * @param goals An array of goals.
+     * @param memory A VectorStoreRetriever instance.
+     * @param messages An array of previous messages.
+     * @param user_input The user's input.
+     * @returns An array of formatted messages.
+     */
     async formatMessages({ goals, memory, messages: previousMessages, user_input, }) {
         const basePrompt = new SystemMessage(this.constructFullPrompt(goals));
         const timePrompt = new SystemMessage(`The current time and date is ${new Date().toLocaleString()}`);
@@ -89,6 +108,12 @@ export class AutoGPTPrompt extends BaseChatPromptTemplate {
         ];
         return messages;
     }
+    /**
+     * This method is not implemented in the AutoGPTPrompt class and will
+     * throw an error if called.
+     * @param _values Partial values.
+     * @returns Throws an error.
+     */
     async partial(_values) {
         throw new Error("Method not implemented.");
     }

package/dist/experimental/autogpt/prompt_generator.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPrompt = exports.PromptGenerator = void 0;
 const zod_to_json_schema_1 = require("zod-to-json-schema");
 const schema_js_1 = require("./schema.cjs");
+/**
+ * Class that generates prompts for generative agents. It maintains a list
+ * of constraints, commands, resources, and performance evaluations.
+ */
 class PromptGenerator {
     constructor() {
         Object.defineProperty(this, "constraints", {
@@ -50,9 +54,19 @@ class PromptGenerator {
             command: { name: "command name", args: { "arg name": "value" } },
         };
     }
+    /**
+     * Adds a constraint to the list of constraints.
+     * @param constraint The constraint to add.
+     * @returns void
+     */
     add_constraint(constraint) {
         this.constraints.push(constraint);
     }
+    /**
+     * Adds a tool to the list of commands.
+     * @param tool The tool to add.
+     * @returns void
+     */
     add_tool(tool) {
         this.commands.push(tool);
     }
@@ -61,9 +75,19 @@ class PromptGenerator {
         output += `, args json schema: ${JSON.stringify((0, zod_to_json_schema_1.zodToJsonSchema)(tool.schema).properties)}`;
         return output;
     }
+    /**
+     * Adds a resource to the list of resources.
+     * @param resource The resource to add.
+     * @returns void
+     */
     add_resource(resource) {
         this.resources.push(resource);
     }
+    /**
+     * Adds a performance evaluation to the list of performance evaluations.
+     * @param evaluation The performance evaluation to add.
+     * @returns void
+     */
     add_performance_evaluation(evaluation) {
         this.performance_evaluation.push(evaluation);
     }
@@ -78,6 +102,11 @@ class PromptGenerator {
         }
         return items.map((item, i) => `${i + 1}. ${item}`).join("\n");
     }
+    /**
+     * Generates a prompt string that includes the constraints, commands,
+     * resources, performance evaluations, and response format.
+     * @returns A string representing the prompt.
+     */
     generate_prompt_string() {
         const formatted_response_format = JSON.stringify(this.response_format, null, 4);
         const prompt_string = `Constraints:\n${this._generate_numbered_list(this.constraints)}\n\n` +
@@ -91,6 +120,9 @@ class PromptGenerator {
     }
 }
 exports.PromptGenerator = PromptGenerator;
+/**
+ * Function that generates a prompt string for a given list of tools.
+ */
 function getPrompt(tools) {
     const prompt_generator = new PromptGenerator();
     prompt_generator.add_constraint("~4000 word limit for short term memory. " +