langchain 0.0.131 → 0.0.132

package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts

@@ -1,11 +1,20 @@
 import { Example } from "../../schema/index.js";
 import { BaseExampleSelector } from "../base.js";
 import { PromptTemplate } from "../prompt.js";
+/**
+ * Interface for the input parameters of the LengthBasedExampleSelector
+ * class.
+ */
 export interface LengthBasedExampleSelectorInput {
     examplePrompt: PromptTemplate;
     maxLength?: number;
     getTextLength?: (text: string) => number;
 }
+/**
+ * A specialized example selector that selects examples based on their
+ * length, ensuring that the total length of the selected examples does
+ * not exceed a specified maximum length.
+ */
 export declare class LengthBasedExampleSelector extends BaseExampleSelector {
     protected examples: Example[];
     examplePrompt: PromptTemplate;
@@ -13,8 +22,32 @@ export declare class LengthBasedExampleSelector extends BaseExampleSelector {
     maxLength: number;
     exampleTextLengths: number[];
     constructor(data: LengthBasedExampleSelectorInput);
+    /**
+     * Adds an example to the list of examples and calculates its length.
+     * @param example The example to be added.
+     * @returns Promise that resolves when the example has been added and its length calculated.
+     */
     addExample(example: Example): Promise<void>;
+    /**
+     * Calculates the lengths of the examples.
+     * @param v Array of lengths of the examples.
+     * @param values Instance of LengthBasedExampleSelector.
+     * @returns Promise that resolves with an array of lengths of the examples.
+     */
     calculateExampleTextLengths(v: number[], values: LengthBasedExampleSelector): Promise<number[]>;
+    /**
+     * Selects examples until the total length of the selected examples
+     * reaches the maxLength.
+     * @param inputVariables The input variables for the examples.
+     * @returns Promise that resolves with an array of selected examples.
+     */
     selectExamples(inputVariables: Example): Promise<Example[]>;
+    /**
+     * Creates a new instance of LengthBasedExampleSelector and adds a list of
+     * examples to it.
+     * @param examples Array of examples to be added.
+     * @param args Input parameters for the LengthBasedExampleSelector.
+     * @returns Promise that resolves with a new instance of LengthBasedExampleSelector with the examples added.
+     */
     static fromExamples(examples: Example[], args: LengthBasedExampleSelectorInput): Promise<LengthBasedExampleSelector>;
 }

package/dist/prompts/selectors/LengthBasedExampleSelector.js

@@ -1,7 +1,15 @@
 import { BaseExampleSelector } from "../base.js";
+/**
+ * Calculates the length of a text based on the number of words and lines.
+ */
 function getLengthBased(text) {
     return text.split(/\n| /).length;
 }
+/**
+ * A specialized example selector that selects examples based on their
+ * length, ensuring that the total length of the selected examples does
+ * not exceed a specified maximum length.
+ */
 export class LengthBasedExampleSelector extends BaseExampleSelector {
     constructor(data) {
         super(data);
@@ -39,11 +47,22 @@ export class LengthBasedExampleSelector extends BaseExampleSelector {
         this.maxLength = data.maxLength ?? 2048;
         this.getTextLength = data.getTextLength ?? getLengthBased;
     }
+    /**
+     * Adds an example to the list of examples and calculates its length.
+     * @param example The example to be added.
+     * @returns Promise that resolves when the example has been added and its length calculated.
+     */
     async addExample(example) {
         this.examples.push(example);
         const stringExample = await this.examplePrompt.format(example);
         this.exampleTextLengths.push(this.getTextLength(stringExample));
     }
+    /**
+     * Calculates the lengths of the examples.
+     * @param v Array of lengths of the examples.
+     * @param values Instance of LengthBasedExampleSelector.
+     * @returns Promise that resolves with an array of lengths of the examples.
+     */
     async calculateExampleTextLengths(v, values) {
         if (v.length > 0) {
             return v;
@@ -52,6 +71,12 @@ export class LengthBasedExampleSelector extends BaseExampleSelector {
         const stringExamples = await Promise.all(examples.map((eg) => examplePrompt.format(eg)));
         return stringExamples.map((eg) => this.getTextLength(eg));
     }
+    /**
+     * Selects examples until the total length of the selected examples
+     * reaches the maxLength.
+     * @param inputVariables The input variables for the examples.
+     * @returns Promise that resolves with an array of selected examples.
+     */
     async selectExamples(inputVariables) {
         const inputs = Object.values(inputVariables).join(" ");
         let remainingLength = this.maxLength - this.getTextLength(inputs);
@@ -70,6 +95,13 @@ export class LengthBasedExampleSelector extends BaseExampleSelector {
         }
         return examples;
     }
+    /**
+     * Creates a new instance of LengthBasedExampleSelector and adds a list of
+     * examples to it.
+     * @param examples Array of examples to be added.
+     * @param args Input parameters for the LengthBasedExampleSelector.
+     * @returns Promise that resolves with a new instance of LengthBasedExampleSelector with the examples added.
+     */
     static async fromExamples(examples, args) {
         const selector = new LengthBasedExampleSelector(args);
         await Promise.all(examples.map((eg) => selector.addExample(eg)));

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs

@@ -8,6 +8,10 @@ function sortedValues(values) {
         .sort()
         .map((key) => values[key]);
 }
+/**
+ * Class that selects examples based on semantic similarity. It extends
+ * the BaseExampleSelector class.
+ */
 class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {
         super(data);
@@ -40,6 +44,12 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
     }
+    /**
+     * Method that adds a new example to the vectorStore. The example is
+     * converted to a string and added to the vectorStore as a document.
+     * @param example The example to be added to the vectorStore.
+     * @returns Promise that resolves when the example has been added to the vectorStore.
+     */
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
@@ -50,6 +60,13 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
             }),
         ]);
     }
+    /**
+     * Method that selects which examples to use based on semantic similarity.
+     * It performs a similarity search in the vectorStore using the input
+     * variables and returns the examples with the highest similarity.
+     * @param inputVariables The input variables used for the similarity search.
+     * @returns Promise that resolves with an array of the selected examples.
+     */
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
@@ -61,6 +78,20 @@ class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
         }
         return examples;
     }
+    /**
+     * Static method that creates a new instance of
+     * SemanticSimilarityExampleSelector. It takes a list of examples, an
+     * instance of Embeddings, a VectorStore class, and an options object as
+     * parameters. It converts the examples to strings, creates a VectorStore
+     * from the strings and the embeddings, and returns a new
+     * SemanticSimilarityExampleSelector with the created VectorStore and the
+     * options provided.
+     * @param examples The list of examples to be used.
+     * @param embeddings The instance of Embeddings to be used.
+     * @param vectorStoreCls The VectorStore class to be used.
+     * @param options The options object for the SemanticSimilarityExampleSelector.
+     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
+     */
     static async fromExamples(examples, embeddings, vectorStoreCls, options = {}) {
         const inputKeys = options.inputKeys ?? null;
         const stringExamples = examples.map((example) => sortedValues(inputKeys

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts

@@ -2,20 +2,55 @@ import { Embeddings } from "../../embeddings/base.js";
 import { VectorStore } from "../../vectorstores/base.js";
 import { Example } from "../../schema/index.js";
 import { BaseExampleSelector } from "../base.js";
+/**
+ * Interface for the input data of the SemanticSimilarityExampleSelector
+ * class.
+ */
 export interface SemanticSimilarityExampleSelectorInput {
     vectorStore: VectorStore;
     k?: number;
     exampleKeys?: string[];
     inputKeys?: string[];
 }
+/**
+ * Class that selects examples based on semantic similarity. It extends
+ * the BaseExampleSelector class.
+ */
 export declare class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     vectorStore: VectorStore;
     k: number;
     exampleKeys?: string[];
     inputKeys?: string[];
     constructor(data: SemanticSimilarityExampleSelectorInput);
+    /**
+     * Method that adds a new example to the vectorStore. The example is
+     * converted to a string and added to the vectorStore as a document.
+     * @param example The example to be added to the vectorStore.
+     * @returns Promise that resolves when the example has been added to the vectorStore.
+     */
     addExample(example: Example): Promise<void>;
+    /**
+     * Method that selects which examples to use based on semantic similarity.
+     * It performs a similarity search in the vectorStore using the input
+     * variables and returns the examples with the highest similarity.
+     * @param inputVariables The input variables used for the similarity search.
+     * @returns Promise that resolves with an array of the selected examples.
+     */
     selectExamples<T>(inputVariables: Record<string, T>): Promise<Example[]>;
+    /**
+     * Static method that creates a new instance of
+     * SemanticSimilarityExampleSelector. It takes a list of examples, an
+     * instance of Embeddings, a VectorStore class, and an options object as
+     * parameters. It converts the examples to strings, creates a VectorStore
+     * from the strings and the embeddings, and returns a new
+     * SemanticSimilarityExampleSelector with the created VectorStore and the
+     * options provided.
+     * @param examples The list of examples to be used.
+     * @param embeddings The instance of Embeddings to be used.
+     * @param vectorStoreCls The VectorStore class to be used.
+     * @param options The options object for the SemanticSimilarityExampleSelector.
+     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
+     */
     static fromExamples<C extends typeof VectorStore>(examples: Record<string, string>[], embeddings: Embeddings, vectorStoreCls: C, options?: {
         k?: number;
         inputKeys?: string[];

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js

@@ -5,6 +5,10 @@ function sortedValues(values) {
         .sort()
         .map((key) => values[key]);
 }
+/**
+ * Class that selects examples based on semantic similarity. It extends
+ * the BaseExampleSelector class.
+ */
 export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
     constructor(data) {
         super(data);
@@ -37,6 +41,12 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
         this.exampleKeys = data.exampleKeys;
         this.inputKeys = data.inputKeys;
     }
+    /**
+     * Method that adds a new example to the vectorStore. The example is
+     * converted to a string and added to the vectorStore as a document.
+     * @param example The example to be added to the vectorStore.
+     * @returns Promise that resolves when the example has been added to the vectorStore.
+     */
     async addExample(example) {
         const inputKeys = this.inputKeys ?? Object.keys(example);
         const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
@@ -47,6 +57,13 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
             }),
         ]);
     }
+    /**
+     * Method that selects which examples to use based on semantic similarity.
+     * It performs a similarity search in the vectorStore using the input
+     * variables and returns the examples with the highest similarity.
+     * @param inputVariables The input variables used for the similarity search.
+     * @returns Promise that resolves with an array of the selected examples.
+     */
     async selectExamples(inputVariables) {
         const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
         const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
@@ -58,6 +75,20 @@ export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
         }
         return examples;
     }
+    /**
+     * Static method that creates a new instance of
+     * SemanticSimilarityExampleSelector. It takes a list of examples, an
+     * instance of Embeddings, a VectorStore class, and an options object as
+     * parameters. It converts the examples to strings, creates a VectorStore
+     * from the strings and the embeddings, and returns a new
+     * SemanticSimilarityExampleSelector with the created VectorStore and the
+     * options provided.
+     * @param examples The list of examples to be used.
+     * @param embeddings The instance of Embeddings to be used.
+     * @param vectorStoreCls The VectorStore class to be used.
+     * @param options The options object for the SemanticSimilarityExampleSelector.
+     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
+     */
     static async fromExamples(examples, embeddings, vectorStoreCls, options = {}) {
         const inputKeys = options.inputKeys ?? null;
         const stringExamples = examples.map((example) => sortedValues(inputKeys

package/dist/prompts/selectors/conditional.cjs

@@ -1,13 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isChatModel = exports.isLLM = exports.ConditionalPromptSelector = exports.BasePromptSelector = void 0;
+/**
+ * Abstract class that defines the interface for selecting a prompt for a
+ * given language model.
+ */
 class BasePromptSelector {
+    /**
+     * Asynchronous version of `getPrompt` that also accepts an options object
+     * for partial variables.
+     * @param llm The language model for which to get a prompt.
+     * @param options Optional object for partial variables.
+     * @returns A Promise that resolves to a prompt template.
+     */
     async getPromptAsync(llm, options) {
         const prompt = this.getPrompt(llm);
         return prompt.partial(options?.partialVariables ?? {});
     }
 }
 exports.BasePromptSelector = BasePromptSelector;
+/**
+ * Concrete implementation of `BasePromptSelector` that selects a prompt
+ * based on a set of conditions. It has a default prompt that it returns
+ * if none of the conditions are met.
+ */
 class ConditionalPromptSelector extends BasePromptSelector {
     constructor(default_prompt, conditionals = []) {
         super();
@@ -26,6 +42,12 @@ class ConditionalPromptSelector extends BasePromptSelector {
         this.defaultPrompt = default_prompt;
         this.conditionals = conditionals;
     }
+    /**
+     * Method that selects a prompt based on a set of conditions. If none of
+     * the conditions are met, it returns the default prompt.
+     * @param llm The language model for which to get a prompt.
+     * @returns A prompt template.
+     */
     getPrompt(llm) {
         for (const [condition, prompt] of this.conditionals) {
             if (condition(llm)) {
@@ -36,10 +58,18 @@ class ConditionalPromptSelector extends BasePromptSelector {
     }
 }
 exports.ConditionalPromptSelector = ConditionalPromptSelector;
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseLLM`.
+ */
 function isLLM(llm) {
     return llm._modelType() === "base_llm";
 }
 exports.isLLM = isLLM;
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseChatModel`.
+ */
 function isChatModel(llm) {
     return llm._modelType() === "base_chat_model";
 }

package/dist/prompts/selectors/conditional.d.ts

@@ -6,10 +6,33 @@ import { PartialValues } from "../../schema/index.js";
 export type BaseGetPromptAsyncOptions = {
     partialVariables?: PartialValues;
 };
+/**
+ * Abstract class that defines the interface for selecting a prompt for a
+ * given language model.
+ */
 export declare abstract class BasePromptSelector {
+    /**
+     * Abstract method that must be implemented by any class that extends
+     * `BasePromptSelector`. It takes a language model as an argument and
+     * returns a prompt template.
+     * @param llm The language model for which to get a prompt.
+     * @returns A prompt template.
+     */
     abstract getPrompt(llm: BaseLanguageModel): BasePromptTemplate;
+    /**
+     * Asynchronous version of `getPrompt` that also accepts an options object
+     * for partial variables.
+     * @param llm The language model for which to get a prompt.
+     * @param options Optional object for partial variables.
+     * @returns A Promise that resolves to a prompt template.
+     */
     getPromptAsync(llm: BaseLanguageModel, options?: BaseGetPromptAsyncOptions): Promise<BasePromptTemplate>;
 }
+/**
+ * Concrete implementation of `BasePromptSelector` that selects a prompt
+ * based on a set of conditions. It has a default prompt that it returns
+ * if none of the conditions are met.
+ */
 export declare class ConditionalPromptSelector extends BasePromptSelector {
     defaultPrompt: BasePromptTemplate;
     conditionals: Array<[
@@ -20,7 +43,21 @@ export declare class ConditionalPromptSelector extends BasePromptSelector {
         condition: (llm: BaseLanguageModel) => boolean,
         prompt: BasePromptTemplate
     ]>);
+    /**
+     * Method that selects a prompt based on a set of conditions. If none of
+     * the conditions are met, it returns the default prompt.
+     * @param llm The language model for which to get a prompt.
+     * @returns A prompt template.
+     */
     getPrompt(llm: BaseLanguageModel): BasePromptTemplate;
 }
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseLLM`.
+ */
 export declare function isLLM(llm: BaseLanguageModel): llm is BaseLLM;
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseChatModel`.
+ */
 export declare function isChatModel(llm: BaseLanguageModel): llm is BaseChatModel;

package/dist/prompts/selectors/conditional.js

@@ -1,9 +1,25 @@
+/**
+ * Abstract class that defines the interface for selecting a prompt for a
+ * given language model.
+ */
 export class BasePromptSelector {
+    /**
+     * Asynchronous version of `getPrompt` that also accepts an options object
+     * for partial variables.
+     * @param llm The language model for which to get a prompt.
+     * @param options Optional object for partial variables.
+     * @returns A Promise that resolves to a prompt template.
+     */
     async getPromptAsync(llm, options) {
         const prompt = this.getPrompt(llm);
         return prompt.partial(options?.partialVariables ?? {});
     }
 }
+/**
+ * Concrete implementation of `BasePromptSelector` that selects a prompt
+ * based on a set of conditions. It has a default prompt that it returns
+ * if none of the conditions are met.
+ */
 export class ConditionalPromptSelector extends BasePromptSelector {
     constructor(default_prompt, conditionals = []) {
         super();
@@ -22,6 +38,12 @@ export class ConditionalPromptSelector extends BasePromptSelector {
         this.defaultPrompt = default_prompt;
         this.conditionals = conditionals;
     }
+    /**
+     * Method that selects a prompt based on a set of conditions. If none of
+     * the conditions are met, it returns the default prompt.
+     * @param llm The language model for which to get a prompt.
+     * @returns A prompt template.
+     */
     getPrompt(llm) {
         for (const [condition, prompt] of this.conditionals) {
             if (condition(llm)) {
@@ -31,9 +53,17 @@ export class ConditionalPromptSelector extends BasePromptSelector {
         return this.defaultPrompt;
     }
 }
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseLLM`.
+ */
 export function isLLM(llm) {
     return llm._modelType() === "base_llm";
 }
+/**
+ * Type guard function that checks if a given language model is of type
+ * `BaseChatModel`.
+ */
 export function isChatModel(llm) {
     return llm._modelType() === "base_chat_model";
 }

package/dist/prompts/serde.d.ts

@@ -1,11 +1,30 @@
 import type { Example } from "../schema/index.js";
 import type { TemplateFormat } from "./template.js";
+/**
+ * Represents a serialized version of a prompt template. This type is used
+ * to create dynamic prompts for language models. It contains an optional
+ * `_type` field which, if present, is set to 'prompt'. It also includes
+ * `input_variables`, an array of strings representing the variables to be
+ * used in the prompt, an optional `template_format` specifying the format
+ * of the template, and an optional `template` which is the actual
+ * template string.
+ */
 export type SerializedPromptTemplate = {
     _type?: "prompt";
     input_variables: string[];
     template_format?: TemplateFormat;
     template?: string;
 };
+/**
+ * Represents a serialized version of a few-shot template. This type
+ * includes an `_type` field set to 'few_shot', `input_variables` which
+ * are an array of strings representing the variables to be used in the
+ * template, `examples` which can be a string or an array of Example
+ * objects, an optional `example_prompt` which is a
+ * SerializedPromptTemplate, `example_separator` which is a string,
+ * optional `prefix` and `suffix` strings, and `template_format` which
+ * specifies the format of the template.
+ */
 export type SerializedFewShotTemplate = {
     _type: "few_shot";
     input_variables: string[];
@@ -16,4 +35,9 @@ export type SerializedFewShotTemplate = {
     suffix?: string;
     template_format: TemplateFormat;
 };
+/**
+ * Represents a serialized version of a base prompt template. This type
+ * can be either a SerializedFewShotTemplate or a
+ * SerializedPromptTemplate.
+ */
 export type SerializedBasePromptTemplate = SerializedFewShotTemplate | SerializedPromptTemplate;

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,6 +4,10 @@ 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";
@@ -55,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) {
@@ -66,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;
@@ -87,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) {
@@ -99,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) : "";
@@ -114,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 [];
@@ -122,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 &&
@@ -142,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);
@@ -157,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 [];
@@ -165,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,