langchain 0.0.130 → 0.0.132

package/dist/prompts/template.d.ts

@@ -1,5 +1,13 @@
 import { InputValues } from "../schema/index.js";
+/**
+ * Type that specifies the format of a template. It can be either
+ * "f-string" or "jinja2".
+ */
 export type TemplateFormat = "f-string" | "jinja2";
+/**
+ * Type that represents a node in a parsed format string. It can be either
+ * a literal text or a variable name.
+ */
 type ParsedFStringNode = {
     type: "literal";
     text: string;
@@ -9,7 +17,16 @@ type ParsedFStringNode = {
 };
 export declare const parseFString: (template: string) => ParsedFStringNode[];
 export declare const interpolateFString: (template: string, values: InputValues) => string;
+/**
+ * Type that represents a function that takes a template string and a set
+ * of input values, and returns a string where all variables in the
+ * template have been replaced with their corresponding values.
+ */
 type Interpolator = (template: string, values: InputValues) => string;
+/**
+ * Type that represents a function that takes a template string and
+ * returns an array of `ParsedFStringNode`.
+ */
 type Parser = (template: string) => ParsedFStringNode[];
 export declare const DEFAULT_FORMATTER_MAPPING: Record<TemplateFormat, Interpolator>;
 export declare const DEFAULT_PARSER_MAPPING: Record<TemplateFormat, Parser>;

package/dist/retrievers/amazon_kendra.cjs

@@ -4,7 +4,14 @@ exports.AmazonKendraRetriever = void 0;
 const client_kendra_1 = require("@aws-sdk/client-kendra");
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
+/**
+ * Class for interacting with Amazon Kendra, an intelligent search service
+ * provided by AWS. Extends the BaseRetriever class.
+ */
 class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "AmazonKendraRetriever";
+    }
     constructor({ indexId, topK = 10, clientOptions, attributeFilter, region, }) {
         super();
         Object.defineProperty(this, "lc_namespace", {
@@ -52,6 +59,12 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         this.indexId = indexId;
     }
     // A method to combine title and excerpt into a single string.
+    /**
+     * Combines title and excerpt into a single string.
+     * @param title The title of the document.
+     * @param excerpt An excerpt from the document.
+     * @returns A single string combining the title and excerpt.
+     */
     combineText(title, excerpt) {
         let text = "";
         if (title) {
@@ -63,11 +76,22 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return text;
     }
     // A method to clean the result text by replacing sequences of whitespace with a single space and removing ellipses.
+    /**
+     * Cleans the result text by replacing sequences of whitespace with a
+     * single space and removing ellipses.
+     * @param resText The result text to clean.
+     * @returns The cleaned result text.
+     */
     cleanResult(resText) {
         const res = resText.replace(/\s+/g, " ").replace(/\.\.\./g, "");
         return res;
     }
     // A method to extract the attribute value from a DocumentAttributeValue object.
+    /**
+     * Extracts the attribute value from a DocumentAttributeValue object.
+     * @param value The DocumentAttributeValue object to extract the value from.
+     * @returns The extracted attribute value.
+     */
     getDocAttributeValue(value) {
         if (value.DateValue) {
             return value.DateValue;
@@ -84,6 +108,12 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return "";
     }
     // A method to extract the attribute key-value pairs from an array of DocumentAttribute objects.
+    /**
+     * Extracts the attribute key-value pairs from an array of
+     * DocumentAttribute objects.
+     * @param documentAttributes The array of DocumentAttribute objects to extract the key-value pairs from.
+     * @returns An object containing the extracted attribute key-value pairs.
+     */
     getDocAttributes(documentAttributes) {
         const attributes = {};
         if (documentAttributes) {
@@ -96,6 +126,11 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return attributes;
     }
     // A method to convert a RetrieveResultItem object into a Document object.
+    /**
+     * Converts a RetrieveResultItem object into a Document object.
+     * @param item The RetrieveResultItem object to convert.
+     * @returns A Document object.
+     */
     convertRetrieverItem(item) {
         const title = item.DocumentTitle || "";
         const excerpt = item.Content ? this.cleanResult(item.Content) : "";
@@ -111,6 +146,12 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return new document_js_1.Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a RetrieveCommandOutput object.
+    /**
+     * Extracts the top-k documents from a RetrieveCommandOutput object.
+     * @param response The RetrieveCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getRetrieverDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -119,6 +160,11 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertRetrieverItem(item));
     }
     // A method to extract the excerpt text from a QueryResultItem object.
+    /**
+     * Extracts the excerpt text from a QueryResultItem object.
+     * @param item The QueryResultItem object to extract the excerpt text from.
+     * @returns The extracted excerpt text.
+     */
     getQueryItemExcerpt(item) {
         if (item.AdditionalAttributes &&
             item.AdditionalAttributes.length &&
@@ -139,6 +185,11 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         }
     }
     // A method to convert a QueryResultItem object into a Document object.
+    /**
+     * Converts a QueryResultItem object into a Document object.
+     * @param item The QueryResultItem object to convert.
+     * @returns A Document object.
+     */
     convertQueryItem(item) {
         const title = item.DocumentTitle?.Text || "";
         const excerpt = this.getQueryItemExcerpt(item);
@@ -154,6 +205,12 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return new document_js_1.Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a QueryCommandOutput object.
+    /**
+     * Extracts the top-k documents from a QueryCommandOutput object.
+     * @param response The QueryCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getQueryDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -162,6 +219,14 @@ class AmazonKendraRetriever extends retriever_js_1.BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertQueryItem(item));
     }
     // A method to send a retrieve or query request to Kendra and return the top-k documents.
+    /**
+     * Sends a retrieve or query request to Kendra and returns the top-k
+     * documents.
+     * @param query The query to send to Kendra.
+     * @param topK The number of top documents to return.
+     * @param attributeFilter Optional filter to apply when retrieving documents.
+     * @returns A Promise that resolves to an array of Document objects.
+     */
     async queryKendra(query, topK, attributeFilter) {
         const retrieveCommand = new client_kendra_1.RetrieveCommand({
             IndexId: this.indexId,

package/dist/retrievers/amazon_kendra.d.ts

@@ -1,6 +1,10 @@
 import { AttributeFilter, DocumentAttribute, DocumentAttributeValue, KendraClient, KendraClientConfig, QueryCommandOutput, QueryResultItem, RetrieveCommandOutput, RetrieveResultItem } from "@aws-sdk/client-kendra";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Interface for the arguments required to initialize an
+ * AmazonKendraRetriever instance.
+ */
 export interface AmazonKendraRetrieverArgs {
     indexId: string;
     topK: number;
@@ -8,19 +12,52 @@ export interface AmazonKendraRetrieverArgs {
     attributeFilter?: AttributeFilter;
     clientOptions?: KendraClientConfig;
 }
+/**
+ * Class for interacting with Amazon Kendra, an intelligent search service
+ * provided by AWS. Extends the BaseRetriever class.
+ */
 export declare class AmazonKendraRetriever extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     indexId: string;
     topK: number;
     kendraClient: KendraClient;
     attributeFilter?: AttributeFilter;
     constructor({ indexId, topK, clientOptions, attributeFilter, region, }: AmazonKendraRetrieverArgs);
+    /**
+     * Combines title and excerpt into a single string.
+     * @param title The title of the document.
+     * @param excerpt An excerpt from the document.
+     * @returns A single string combining the title and excerpt.
+     */
     combineText(title?: string, excerpt?: string): string;
+    /**
+     * Cleans the result text by replacing sequences of whitespace with a
+     * single space and removing ellipses.
+     * @param resText The result text to clean.
+     * @returns The cleaned result text.
+     */
     cleanResult(resText: string): string;
+    /**
+     * Extracts the attribute value from a DocumentAttributeValue object.
+     * @param value The DocumentAttributeValue object to extract the value from.
+     * @returns The extracted attribute value.
+     */
     getDocAttributeValue(value: DocumentAttributeValue): string | number | string[] | Date;
+    /**
+     * Extracts the attribute key-value pairs from an array of
+     * DocumentAttribute objects.
+     * @param documentAttributes The array of DocumentAttribute objects to extract the key-value pairs from.
+     * @returns An object containing the extracted attribute key-value pairs.
+     */
     getDocAttributes(documentAttributes?: DocumentAttribute[]): {
         [key: string]: unknown;
     };
+    /**
+     * Converts a RetrieveResultItem object into a Document object.
+     * @param item The RetrieveResultItem object to convert.
+     * @returns A Document object.
+     */
     convertRetrieverItem(item: RetrieveResultItem): Document<{
         source: string | undefined;
         title: string;
@@ -29,8 +66,24 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>;
+    /**
+     * Extracts the top-k documents from a RetrieveCommandOutput object.
+     * @param response The RetrieveCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getRetrieverDocs(response: RetrieveCommandOutput, pageSize: number): Document[];
+    /**
+     * Extracts the excerpt text from a QueryResultItem object.
+     * @param item The QueryResultItem object to extract the excerpt text from.
+     * @returns The extracted excerpt text.
+     */
     getQueryItemExcerpt(item: QueryResultItem): string;
+    /**
+     * Converts a QueryResultItem object into a Document object.
+     * @param item The QueryResultItem object to convert.
+     * @returns A Document object.
+     */
     convertQueryItem(item: QueryResultItem): Document<{
         source: string | undefined;
         title: string;
@@ -39,6 +92,12 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>;
+    /**
+     * Extracts the top-k documents from a QueryCommandOutput object.
+     * @param response The QueryCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getQueryDocs(response: QueryCommandOutput, pageSize: number): Document<{
         source: string | undefined;
         title: string;
@@ -47,6 +106,14 @@ export declare class AmazonKendraRetriever extends BaseRetriever {
             [key: string]: unknown;
         };
     }>[];
+    /**
+     * Sends a retrieve or query request to Kendra and returns the top-k
+     * documents.
+     * @param query The query to send to Kendra.
+     * @param topK The number of top documents to return.
+     * @param attributeFilter Optional filter to apply when retrieving documents.
+     * @returns A Promise that resolves to an array of Document objects.
+     */
     queryKendra(query: string, topK: number, attributeFilter?: AttributeFilter): Promise<Document<Record<string, any>>[] | Document<{
         source: string | undefined;
         title: string;

package/dist/retrievers/amazon_kendra.js

@@ -1,7 +1,14 @@
 import { KendraClient, QueryCommand, RetrieveCommand, } from "@aws-sdk/client-kendra";
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
+/**
+ * Class for interacting with Amazon Kendra, an intelligent search service
+ * provided by AWS. Extends the BaseRetriever class.
+ */
 export class AmazonKendraRetriever extends BaseRetriever {
+    static lc_name() {
+        return "AmazonKendraRetriever";
+    }
     constructor({ indexId, topK = 10, clientOptions, attributeFilter, region, }) {
         super();
         Object.defineProperty(this, "lc_namespace", {
@@ -49,6 +56,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         this.indexId = indexId;
     }
     // A method to combine title and excerpt into a single string.
+    /**
+     * Combines title and excerpt into a single string.
+     * @param title The title of the document.
+     * @param excerpt An excerpt from the document.
+     * @returns A single string combining the title and excerpt.
+     */
     combineText(title, excerpt) {
         let text = "";
         if (title) {
@@ -60,11 +73,22 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return text;
     }
     // A method to clean the result text by replacing sequences of whitespace with a single space and removing ellipses.
+    /**
+     * Cleans the result text by replacing sequences of whitespace with a
+     * single space and removing ellipses.
+     * @param resText The result text to clean.
+     * @returns The cleaned result text.
+     */
     cleanResult(resText) {
         const res = resText.replace(/\s+/g, " ").replace(/\.\.\./g, "");
         return res;
     }
     // A method to extract the attribute value from a DocumentAttributeValue object.
+    /**
+     * Extracts the attribute value from a DocumentAttributeValue object.
+     * @param value The DocumentAttributeValue object to extract the value from.
+     * @returns The extracted attribute value.
+     */
     getDocAttributeValue(value) {
         if (value.DateValue) {
             return value.DateValue;
@@ -81,6 +105,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return "";
     }
     // A method to extract the attribute key-value pairs from an array of DocumentAttribute objects.
+    /**
+     * Extracts the attribute key-value pairs from an array of
+     * DocumentAttribute objects.
+     * @param documentAttributes The array of DocumentAttribute objects to extract the key-value pairs from.
+     * @returns An object containing the extracted attribute key-value pairs.
+     */
     getDocAttributes(documentAttributes) {
         const attributes = {};
         if (documentAttributes) {
@@ -93,6 +123,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return attributes;
     }
     // A method to convert a RetrieveResultItem object into a Document object.
+    /**
+     * Converts a RetrieveResultItem object into a Document object.
+     * @param item The RetrieveResultItem object to convert.
+     * @returns A Document object.
+     */
     convertRetrieverItem(item) {
         const title = item.DocumentTitle || "";
         const excerpt = item.Content ? this.cleanResult(item.Content) : "";
@@ -108,6 +143,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return new Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a RetrieveCommandOutput object.
+    /**
+     * Extracts the top-k documents from a RetrieveCommandOutput object.
+     * @param response The RetrieveCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getRetrieverDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -116,6 +157,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertRetrieverItem(item));
     }
     // A method to extract the excerpt text from a QueryResultItem object.
+    /**
+     * Extracts the excerpt text from a QueryResultItem object.
+     * @param item The QueryResultItem object to extract the excerpt text from.
+     * @returns The extracted excerpt text.
+     */
     getQueryItemExcerpt(item) {
         if (item.AdditionalAttributes &&
             item.AdditionalAttributes.length &&
@@ -136,6 +182,11 @@ export class AmazonKendraRetriever extends BaseRetriever {
         }
     }
     // A method to convert a QueryResultItem object into a Document object.
+    /**
+     * Converts a QueryResultItem object into a Document object.
+     * @param item The QueryResultItem object to convert.
+     * @returns A Document object.
+     */
     convertQueryItem(item) {
         const title = item.DocumentTitle?.Text || "";
         const excerpt = this.getQueryItemExcerpt(item);
@@ -151,6 +202,12 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return new Document({ pageContent, metadata });
     }
     // A method to extract the top-k documents from a QueryCommandOutput object.
+    /**
+     * Extracts the top-k documents from a QueryCommandOutput object.
+     * @param response The QueryCommandOutput object to extract the documents from.
+     * @param pageSize The number of documents to extract.
+     * @returns An array of Document objects.
+     */
     getQueryDocs(response, pageSize) {
         if (!response.ResultItems)
             return [];
@@ -159,6 +216,14 @@ export class AmazonKendraRetriever extends BaseRetriever {
         return response.ResultItems.slice(0, count).map((item) => this.convertQueryItem(item));
     }
     // A method to send a retrieve or query request to Kendra and return the top-k documents.
+    /**
+     * Sends a retrieve or query request to Kendra and returns the top-k
+     * documents.
+     * @param query The query to send to Kendra.
+     * @param topK The number of top documents to return.
+     * @param attributeFilter Optional filter to apply when retrieving documents.
+     * @returns A Promise that resolves to an array of Document objects.
+     */
     async queryKendra(query, topK, attributeFilter) {
         const retrieveCommand = new RetrieveCommand({
             IndexId: this.indexId,

package/dist/retrievers/contextual_compression.cjs

@@ -2,7 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextualCompressionRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 class ContextualCompressionRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "ContextualCompressionRetriever";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {

package/dist/retrievers/contextual_compression.d.ts

@@ -2,11 +2,22 @@ import { BaseDocumentCompressor } from "./document_compressors/index.js";
 import { Document } from "../document.js";
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
+/**
+ * Interface for the arguments required to construct a
+ * ContextualCompressionRetriever. It extends the BaseRetrieverInput
+ * interface with two additional fields: baseCompressor and baseRetriever.
+ */
 export interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {
     baseCompressor: BaseDocumentCompressor;
     baseRetriever: BaseRetriever;
 }
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 export declare class ContextualCompressionRetriever extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     baseCompressor: BaseDocumentCompressor;
     baseRetriever: BaseRetriever;

package/dist/retrievers/contextual_compression.js

@@ -1,5 +1,13 @@
 import { BaseRetriever } from "../schema/retriever.js";
+/**
+ * A retriever that wraps a base retriever and compresses the results. It
+ * retrieves relevant documents based on a given query and then compresses
+ * these documents using a specified document compressor.
+ */
 export class ContextualCompressionRetriever extends BaseRetriever {
+    static lc_name() {
+        return "ContextualCompressionRetriever";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "lc_namespace", {

package/dist/retrievers/databerry.cjs

@@ -4,7 +4,15 @@ exports.DataberryRetriever = void 0;
 const retriever_js_1 = require("../schema/retriever.cjs");
 const document_js_1 = require("../document.cjs");
 const async_caller_js_1 = require("../util/async_caller.cjs");
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 class DataberryRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "DataberryRetriever";
+    }
     get lc_secrets() {
         return { apiKey: "DATABERRY_API_KEY" };
     }

package/dist/retrievers/databerry.d.ts

@@ -1,12 +1,22 @@
 import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
 import { Document } from "../document.js";
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
+/**
+ * Interface for the arguments required to create a new instance of
+ * DataberryRetriever.
+ */
 export interface DataberryRetrieverArgs extends AsyncCallerParams, BaseRetrieverInput {
     datastoreUrl: string;
     topK?: number;
     apiKey?: string;
 }
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 export declare class DataberryRetriever extends BaseRetriever {
+    static lc_name(): string;
     lc_namespace: string[];
     get lc_secrets(): {
         apiKey: string;

package/dist/retrievers/databerry.js

@@ -1,7 +1,15 @@
 import { BaseRetriever } from "../schema/retriever.js";
 import { Document } from "../document.js";
 import { AsyncCaller } from "../util/async_caller.js";
+/**
+ * A specific implementation of a document retriever for the Databerry
+ * API. It extends the BaseRetriever class, which is an abstract base
+ * class for a document retrieval system in LangChain.
+ */
 export class DataberryRetriever extends BaseRetriever {
+    static lc_name() {
+        return "DataberryRetriever";
+    }
     get lc_secrets() {
         return { apiKey: "DATABERRY_API_KEY" };
     }

package/dist/retrievers/document_compressors/chain_extract.cjs

@@ -51,6 +51,10 @@ function getDefaultChainPrompt() {
         outputParser,
     });
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
     constructor({ llmChain, getInput }) {
         super();
@@ -69,6 +73,12 @@ class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
         this.llmChain = llmChain;
         this.getInput = getInput;
     }
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     async compressDocuments(documents, query) {
         const compressedDocs = await Promise.all(documents.map(async (doc) => {
             const input = this.getInput(query, doc);
@@ -82,6 +92,14 @@ class LLMChainExtractor extends index_js_2.BaseDocumentCompressor {
         }));
         return compressedDocs.filter((doc) => doc !== undefined);
     }
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm, prompt, getInput) {
         const _prompt = prompt || getDefaultChainPrompt();
         const _getInput = getInput || defaultGetInput;

package/dist/retrievers/document_compressors/chain_extract.d.ts

@@ -3,14 +3,36 @@ import { LLMChain } from "../../chains/llm_chain.js";
 import { PromptTemplate } from "../../prompts/index.js";
 import { BaseLanguageModel } from "../../base_language/index.js";
 import { BaseDocumentCompressor } from "./index.js";
+/**
+ * Interface for the arguments required to create an instance of
+ * LLMChainExtractor.
+ */
 export interface LLMChainExtractorArgs {
     llmChain: LLMChain;
     getInput: (query: string, doc: Document) => Record<string, unknown>;
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 export declare class LLMChainExtractor extends BaseDocumentCompressor {
     llmChain: LLMChain;
     getInput: (query: string, doc: Document) => Record<string, unknown>;
     constructor({ llmChain, getInput }: LLMChainExtractorArgs);
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     compressDocuments(documents: Document[], query: string): Promise<Document[]>;
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm: BaseLanguageModel, prompt?: PromptTemplate, getInput?: (query: string, doc: Document) => Record<string, unknown>): LLMChainExtractor;
 }

package/dist/retrievers/document_compressors/chain_extract.js

@@ -48,6 +48,10 @@ function getDefaultChainPrompt() {
         outputParser,
     });
 }
+/**
+ * A class that uses an LLM chain to extract relevant parts of documents.
+ * It extends the BaseDocumentCompressor class.
+ */
 export class LLMChainExtractor extends BaseDocumentCompressor {
     constructor({ llmChain, getInput }) {
         super();
@@ -66,6 +70,12 @@ export class LLMChainExtractor extends BaseDocumentCompressor {
         this.llmChain = llmChain;
         this.getInput = getInput;
     }
+    /**
+     * Compresses a list of documents based on the output of an LLM chain.
+     * @param documents The list of documents to be compressed.
+     * @param query The query to be used for document compression.
+     * @returns A list of compressed documents.
+     */
     async compressDocuments(documents, query) {
         const compressedDocs = await Promise.all(documents.map(async (doc) => {
             const input = this.getInput(query, doc);
@@ -79,6 +89,14 @@ export class LLMChainExtractor extends BaseDocumentCompressor {
         }));
         return compressedDocs.filter((doc) => doc !== undefined);
     }
+    /**
+     * Creates a new instance of LLMChainExtractor from a given LLM, prompt
+     * template, and getInput function.
+     * @param llm The BaseLanguageModel instance used for document extraction.
+     * @param prompt The PromptTemplate instance used for document extraction.
+     * @param getInput A function used for constructing the chain input from the query and a Document.
+     * @returns A new instance of LLMChainExtractor.
+     */
     static fromLLM(llm, prompt, getInput) {
         const _prompt = prompt || getDefaultChainPrompt();
         const _getInput = getInput || defaultGetInput;

package/dist/retrievers/document_compressors/index.d.ts

@@ -3,5 +3,14 @@ import { Document } from "../../document.js";
  * Base Document Compression class. All compressors should extend this class.
  */
 export declare abstract class BaseDocumentCompressor {
+    /**
+     * Abstract method that must be implemented by any class that extends
+     * `BaseDocumentCompressor`. This method takes an array of `Document`
+     * objects and a query string as parameters and returns a Promise that
+     * resolves with an array of compressed `Document` objects.
+     * @param documents An array of `Document` objects to be compressed.
+     * @param query A query string.
+     * @returns A Promise that resolves with an array of compressed `Document` objects.
+     */
     abstract compressDocuments(documents: Document[], query: string): Promise<Document[]>;
 }