langchain 0.0.131 → 0.0.132

package/dist/embeddings/hf.cjs

@@ -4,6 +4,11 @@ exports.HuggingFaceInferenceEmbeddings = void 0;
 const inference_1 = require("@huggingface/inference");
 const base_js_1 = require("./base.cjs");
 const env_js_1 = require("../util/env.cjs");
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using Hugging Face models through the
+ * HuggingFaceInference API.
+ */
 class HuggingFaceInferenceEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -39,9 +44,24 @@ class HuggingFaceInferenceEmbeddings extends base_js_1.Embeddings {
             inputs: clean,
         }));
     }
+    /**
+     * 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 returns the first embedding in the
+     * resulting array.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the document.
+     */
     embedQuery(document) {
         return this._embed([document]).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.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     embedDocuments(documents) {
         return this._embed(documents);
     }

package/dist/embeddings/hf.d.ts

@@ -1,15 +1,39 @@
 import { HfInference } from "@huggingface/inference";
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the HuggingFaceInferenceEmbeddings class.
+ */
 export interface HuggingFaceInferenceEmbeddingsParams extends EmbeddingsParams {
     apiKey?: string;
     model?: string;
 }
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using Hugging Face models through the
+ * HuggingFaceInference API.
+ */
 export declare class HuggingFaceInferenceEmbeddings extends Embeddings implements HuggingFaceInferenceEmbeddingsParams {
     apiKey?: string;
     model: string;
     client: HfInference;
     constructor(fields?: HuggingFaceInferenceEmbeddingsParams);
     _embed(texts: string[]): Promise<number[][]>;
+    /**
+     * 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 returns the first embedding in the
+     * resulting array.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the 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.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
 }

package/dist/embeddings/hf.js

@@ -1,6 +1,11 @@
 import { HfInference } from "@huggingface/inference";
 import { Embeddings } from "./base.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using Hugging Face models through the
+ * HuggingFaceInference API.
+ */
 export class HuggingFaceInferenceEmbeddings extends Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -36,9 +41,24 @@ export class HuggingFaceInferenceEmbeddings extends Embeddings {
             inputs: clean,
         }));
     }
+    /**
+     * 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 returns the first embedding in the
+     * resulting array.
+     * @param document Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the document.
+     */
     embedQuery(document) {
         return this._embed([document]).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.
+     * @param documents Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     embedDocuments(documents) {
         return this._embed(documents);
     }

package/dist/embeddings/openai.cjs

@@ -10,6 +10,11 @@ const axios_fetch_adapter_js_1 = __importDefault(require("../util/axios-fetch-ad
 const chunk_js_1 = require("../util/chunk.cjs");
 const base_js_1 = require("./base.cjs");
 const azure_js_1 = require("../util/azure.cjs");
+/**
+ * Class for generating embeddings using the OpenAI API. Extends the
+ * Embeddings class and implements OpenAIEmbeddingsParams and
+ * AzureOpenAIInput.
+ */
 class OpenAIEmbeddings extends base_js_1.Embeddings {
     constructor(fields, configuration) {
         const fieldsWithDefaults = { maxConcurrency: 2, ...fields };
@@ -124,6 +129,13 @@ class OpenAIEmbeddings extends base_js_1.Embeddings {
             ...configuration,
         };
     }
+    /**
+     * Method to generate embeddings for an array of documents. Splits the
+     * documents into batches and makes requests to the OpenAI API to generate
+     * embeddings.
+     * @param texts Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     async embedDocuments(texts) {
         const batches = (0, chunk_js_1.chunkArray)(this.stripNewLines ? texts.map((t) => t.replace(/\n/g, " ")) : texts, this.batchSize);
         const batchRequests = batches.map((batch) => this.embeddingWithRetry({
@@ -141,6 +153,12 @@ class OpenAIEmbeddings extends base_js_1.Embeddings {
         }
         return embeddings;
     }
+    /**
+     * Method to generate an embedding for a single document. Calls the
+     * embeddingWithRetry method with the document as the input.
+     * @param text Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the document.
+     */
     async embedQuery(text) {
         const { data } = await this.embeddingWithRetry({
             model: this.modelName,
@@ -148,6 +166,13 @@ class OpenAIEmbeddings extends base_js_1.Embeddings {
         });
         return data.data[0].embedding;
     }
+    /**
+     * Private method to make a request to the OpenAI API to generate
+     * embeddings. Handles the retry logic and returns the response from the
+     * API.
+     * @param request Request to send to the OpenAI API.
+     * @returns Promise that resolves to the response from the API.
+     */
     async embeddingWithRetry(request) {
         if (!this.client) {
             const openAIEndpointConfig = {

package/dist/embeddings/openai.d.ts

@@ -1,6 +1,10 @@
 import { ConfigurationParameters } from "openai";
 import { AzureOpenAIInput } from "../types/openai-types.js";
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * Interface for OpenAIEmbeddings parameters. Extends EmbeddingsParams and
+ * defines additional parameters specific to the OpenAIEmbeddings class.
+ */
 export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
     /** Model name to use */
     modelName: string;
@@ -19,6 +23,11 @@ export interface OpenAIEmbeddingsParams extends EmbeddingsParams {
      */
     stripNewLines?: boolean;
 }
+/**
+ * Class for generating embeddings using the OpenAI API. Extends the
+ * Embeddings class and implements OpenAIEmbeddingsParams and
+ * AzureOpenAIInput.
+ */
 export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbeddingsParams, AzureOpenAIInput {
     modelName: string;
     batchSize: number;
@@ -35,7 +44,27 @@ export declare class OpenAIEmbeddings extends Embeddings implements OpenAIEmbedd
         verbose?: boolean;
         openAIApiKey?: string;
     }, configuration?: ConfigurationParameters);
+    /**
+     * Method to generate embeddings for an array of documents. Splits the
+     * documents into batches and makes requests to the OpenAI API to generate
+     * embeddings.
+     * @param texts Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     embedDocuments(texts: string[]): Promise<number[][]>;
+    /**
+     * Method to generate an embedding for a single document. Calls the
+     * embeddingWithRetry method with the document as the input.
+     * @param text Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the document.
+     */
     embedQuery(text: string): Promise<number[]>;
+    /**
+     * Private method to make a request to the OpenAI API to generate
+     * embeddings. Handles the retry logic and returns the response from the
+     * API.
+     * @param request Request to send to the OpenAI API.
+     * @returns Promise that resolves to the response from the API.
+     */
     private embeddingWithRetry;
 }

package/dist/embeddings/openai.js

@@ -4,6 +4,11 @@ import fetchAdapter from "../util/axios-fetch-adapter.js";
 import { chunkArray } from "../util/chunk.js";
 import { Embeddings } from "./base.js";
 import { getEndpoint } from "../util/azure.js";
+/**
+ * Class for generating embeddings using the OpenAI API. Extends the
+ * Embeddings class and implements OpenAIEmbeddingsParams and
+ * AzureOpenAIInput.
+ */
 export class OpenAIEmbeddings extends Embeddings {
     constructor(fields, configuration) {
         const fieldsWithDefaults = { maxConcurrency: 2, ...fields };
@@ -118,6 +123,13 @@ export class OpenAIEmbeddings extends Embeddings {
             ...configuration,
         };
     }
+    /**
+     * Method to generate embeddings for an array of documents. Splits the
+     * documents into batches and makes requests to the OpenAI API to generate
+     * embeddings.
+     * @param texts Array of documents to generate embeddings for.
+     * @returns Promise that resolves to a 2D array of embeddings for each document.
+     */
     async embedDocuments(texts) {
         const batches = chunkArray(this.stripNewLines ? texts.map((t) => t.replace(/\n/g, " ")) : texts, this.batchSize);
         const batchRequests = batches.map((batch) => this.embeddingWithRetry({
@@ -135,6 +147,12 @@ export class OpenAIEmbeddings extends Embeddings {
         }
         return embeddings;
     }
+    /**
+     * Method to generate an embedding for a single document. Calls the
+     * embeddingWithRetry method with the document as the input.
+     * @param text Document to generate an embedding for.
+     * @returns Promise that resolves to an embedding for the document.
+     */
     async embedQuery(text) {
         const { data } = await this.embeddingWithRetry({
             model: this.modelName,
@@ -142,6 +160,13 @@ export class OpenAIEmbeddings extends Embeddings {
         });
         return data.data[0].embedding;
     }
+    /**
+     * Private method to make a request to the OpenAI API to generate
+     * embeddings. Handles the retry logic and returns the response from the
+     * API.
+     * @param request Request to send to the OpenAI API.
+     * @returns Promise that resolves to the response from the API.
+     */
     async embeddingWithRetry(request) {
         if (!this.client) {
             const openAIEndpointConfig = {

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/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>;
 }