langchain 0.0.130 → 0.0.132

package/dist/chains/analyze_documents_chain.d.ts

@@ -4,6 +4,10 @@ import { ChainValues } from "../schema/index.js";
 import { SerializedAnalyzeDocumentChain } from "./serde.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
 export type LoadValues = Record<string, any>;
+/**
+ * Interface for the input parameters required by the AnalyzeDocumentChain
+ * class.
+ */
 export interface AnalyzeDocumentChainInput extends Omit<ChainInputs, "memory"> {
     combineDocumentsChain: BaseChain;
     textSplitter?: TextSplitter;
@@ -15,6 +19,7 @@ export interface AnalyzeDocumentChainInput extends Omit<ChainInputs, "memory"> {
  * @augments StuffDocumentsChainInput
  */
 export declare class AnalyzeDocumentChain extends BaseChain implements AnalyzeDocumentChainInput {
+    static lc_name(): string;
     inputKey: string;
     combineDocumentsChain: BaseChain;
     textSplitter: TextSplitter;

package/dist/chains/analyze_documents_chain.js

@@ -6,6 +6,9 @@ import { RecursiveCharacterTextSplitter, } from "../text_splitter.js";
  * @augments StuffDocumentsChainInput
  */
 export class AnalyzeDocumentChain extends BaseChain {
+    static lc_name() {
+        return "AnalyzeDocumentChain";
+    }
     constructor(fields) {
         super(fields);
         Object.defineProperty(this, "inputKey", {

package/dist/chains/api/api_chain.cjs

@@ -4,6 +4,10 @@ exports.APIChain = void 0;
 const base_js_1 = require("../base.cjs");
 const llm_chain_js_1 = require("../llm_chain.cjs");
 const prompts_js_1 = require("./prompts.cjs");
+/**
+ * Class that extends BaseChain and represents a chain specifically
+ * designed for making API requests and processing API responses.
+ */
 class APIChain extends base_js_1.BaseChain {
     get inputKeys() {
         return [this.inputKey];
@@ -93,6 +97,14 @@ class APIChain extends base_js_1.BaseChain {
             api_docs: this.apiDocs,
         };
     }
+    /**
+     * Static method to create a new APIChain from a BaseLanguageModel and API
+     * documentation.
+     * @param llm BaseLanguageModel instance.
+     * @param apiDocs API documentation.
+     * @param options Optional configuration options for the APIChain.
+     * @returns New APIChain instance.
+     */
     static fromLLMAndAPIDocs(llm, apiDocs, options = {}) {
         const { apiUrlPrompt = prompts_js_1.API_URL_PROMPT_TEMPLATE, apiResponsePrompt = prompts_js_1.API_RESPONSE_PROMPT_TEMPLATE, } = options;
         const apiRequestChain = new llm_chain_js_1.LLMChain({ prompt: apiUrlPrompt, llm });

package/dist/chains/api/api_chain.d.ts

@@ -5,6 +5,10 @@ import { BaseLanguageModel } from "../../base_language/index.js";
 import { CallbackManagerForChainRun } from "../../callbacks/manager.js";
 import { ChainValues } from "../../schema/index.js";
 import { BasePromptTemplate } from "../../index.js";
+/**
+ * Interface that extends ChainInputs and defines additional input
+ * parameters specific to an APIChain.
+ */
 export interface APIChainInput extends Omit<ChainInputs, "memory"> {
     apiAnswerChain: LLMChain;
     apiRequestChain: LLMChain;
@@ -14,11 +18,18 @@ export interface APIChainInput extends Omit<ChainInputs, "memory"> {
     /** Key to use for output, defaults to `output` */
     outputKey?: string;
 }
+/**
+ * Type that defines optional configuration options for an APIChain.
+ */
 export type APIChainOptions = {
     headers?: Record<string, string>;
     apiUrlPrompt?: BasePromptTemplate;
     apiResponsePrompt?: BasePromptTemplate;
 };
+/**
+ * Class that extends BaseChain and represents a chain specifically
+ * designed for making API requests and processing API responses.
+ */
 export declare class APIChain extends BaseChain implements APIChainInput {
     apiAnswerChain: LLMChain;
     apiRequestChain: LLMChain;
@@ -34,5 +45,13 @@ export declare class APIChain extends BaseChain implements APIChainInput {
     _chainType(): "api_chain";
     static deserialize(data: SerializedAPIChain): Promise<APIChain>;
     serialize(): SerializedAPIChain;
+    /**
+     * Static method to create a new APIChain from a BaseLanguageModel and API
+     * documentation.
+     * @param llm BaseLanguageModel instance.
+     * @param apiDocs API documentation.
+     * @param options Optional configuration options for the APIChain.
+     * @returns New APIChain instance.
+     */
     static fromLLMAndAPIDocs(llm: BaseLanguageModel, apiDocs: string, options?: APIChainOptions & Omit<APIChainInput, "apiAnswerChain" | "apiRequestChain" | "apiDocs">): APIChain;
 }

package/dist/chains/api/api_chain.js

@@ -1,6 +1,10 @@
 import { BaseChain } from "../base.js";
 import { LLMChain } from "../llm_chain.js";
 import { API_URL_PROMPT_TEMPLATE, API_RESPONSE_PROMPT_TEMPLATE, } from "./prompts.js";
+/**
+ * Class that extends BaseChain and represents a chain specifically
+ * designed for making API requests and processing API responses.
+ */
 export class APIChain extends BaseChain {
     get inputKeys() {
         return [this.inputKey];
@@ -90,6 +94,14 @@ export class APIChain extends BaseChain {
             api_docs: this.apiDocs,
         };
     }
+    /**
+     * Static method to create a new APIChain from a BaseLanguageModel and API
+     * documentation.
+     * @param llm BaseLanguageModel instance.
+     * @param apiDocs API documentation.
+     * @param options Optional configuration options for the APIChain.
+     * @returns New APIChain instance.
+     */
     static fromLLMAndAPIDocs(llm, apiDocs, options = {}) {
         const { apiUrlPrompt = API_URL_PROMPT_TEMPLATE, apiResponsePrompt = API_RESPONSE_PROMPT_TEMPLATE, } = options;
         const apiRequestChain = new LLMChain({ prompt: apiUrlPrompt, llm });

package/dist/chains/base.cjs

@@ -41,6 +41,12 @@ class BaseChain extends index_js_2.BaseLangChain {
         }
         return valuesForMemory;
     }
+    /**
+     * Invoke the chain with the provided input and returns the output.
+     * @param input Input values for the chain run.
+     * @param config Optional configuration for the Runnable.
+     * @returns Promise that resolves with the output of the chain run.
+     */
     async invoke(input, config) {
         return this.call(input, config);
     }

package/dist/chains/base.d.ts

@@ -25,6 +25,12 @@ export declare abstract class BaseChain<RunInput extends ChainValues = ChainValu
     callbacks?: Callbacks);
     /** @ignore */
     _selectMemoryInputs(values: ChainValues): ChainValues;
+    /**
+     * Invoke the chain with the provided input and returns the output.
+     * @param input Input values for the chain run.
+     * @param config Optional configuration for the Runnable.
+     * @returns Promise that resolves with the output of the chain run.
+     */
     invoke(input: RunInput, config?: RunnableConfig): Promise<RunOutput>;
     /**
      * Run the core logic of this chain and return the output

package/dist/chains/base.js

@@ -38,6 +38,12 @@ export class BaseChain extends BaseLangChain {
         }
         return valuesForMemory;
     }
+    /**
+     * Invoke the chain with the provided input and returns the output.
+     * @param input Input values for the chain run.
+     * @param config Optional configuration for the Runnable.
+     * @returns Promise that resolves with the output of the chain run.
+     */
     async invoke(input, config) {
         return this.call(input, config);
     }

package/dist/chains/chat_vector_db_chain.cjs

@@ -147,6 +147,14 @@ class ChatVectorDBQAChain extends base_js_1.BaseChain {
             k: this.k,
         };
     }
+    /**
+     * Creates an instance of ChatVectorDBQAChain using a BaseLanguageModel
+     * and other options.
+     * @param llm Instance of BaseLanguageModel used to generate a new question.
+     * @param vectorstore Instance of VectorStore used for vector operations.
+     * @param options (Optional) Additional options for creating the ChatVectorDBQAChain instance.
+     * @returns New instance of ChatVectorDBQAChain.
+     */
     static fromLLM(llm, vectorstore, options = {}) {
         const { questionGeneratorTemplate, qaTemplate, verbose, ...rest } = options;
         const question_generator_prompt = prompt_js_1.PromptTemplate.fromTemplate(questionGeneratorTemplate || question_generator_template);

package/dist/chains/chat_vector_db_chain.d.ts

@@ -6,6 +6,9 @@ import { BaseChain, ChainInputs } from "./base.js";
 import { LLMChain } from "./llm_chain.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
 export type LoadValues = Record<string, any>;
+/**
+ * Interface for the input parameters of the ChatVectorDBQAChain class.
+ */
 export interface ChatVectorDBQAChainInput extends ChainInputs {
     vectorstore: VectorStore;
     combineDocumentsChain: BaseChain;
@@ -33,6 +36,14 @@ export declare class ChatVectorDBQAChain extends BaseChain implements ChatVector
     _chainType(): "chat-vector-db";
     static deserialize(data: SerializedChatVectorDBQAChain, values: LoadValues): Promise<ChatVectorDBQAChain>;
     serialize(): SerializedChatVectorDBQAChain;
+    /**
+     * Creates an instance of ChatVectorDBQAChain using a BaseLanguageModel
+     * and other options.
+     * @param llm Instance of BaseLanguageModel used to generate a new question.
+     * @param vectorstore Instance of VectorStore used for vector operations.
+     * @param options (Optional) Additional options for creating the ChatVectorDBQAChain instance.
+     * @returns New instance of ChatVectorDBQAChain.
+     */
     static fromLLM(llm: BaseLanguageModel, vectorstore: VectorStore, options?: {
         inputKey?: string;
         outputKey?: string;

package/dist/chains/chat_vector_db_chain.js

@@ -144,6 +144,14 @@ export class ChatVectorDBQAChain extends BaseChain {
             k: this.k,
         };
     }
+    /**
+     * Creates an instance of ChatVectorDBQAChain using a BaseLanguageModel
+     * and other options.
+     * @param llm Instance of BaseLanguageModel used to generate a new question.
+     * @param vectorstore Instance of VectorStore used for vector operations.
+     * @param options (Optional) Additional options for creating the ChatVectorDBQAChain instance.
+     * @returns New instance of ChatVectorDBQAChain.
+     */
     static fromLLM(llm, vectorstore, options = {}) {
         const { questionGeneratorTemplate, qaTemplate, verbose, ...rest } = options;
         const question_generator_prompt = PromptTemplate.fromTemplate(questionGeneratorTemplate || question_generator_template);

package/dist/chains/combine_docs_chain.cjs

@@ -10,6 +10,9 @@ const prompt_js_1 = require("../prompts/prompt.cjs");
  * @augments StuffDocumentsChainInput
  */
 class StuffDocumentsChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "StuffDocumentsChain";
+    }
     get inputKeys() {
         return [this.inputKey, ...this.llmChain.inputKeys].filter((key) => key !== this.documentVariableName);
     }
@@ -84,6 +87,9 @@ exports.StuffDocumentsChain = StuffDocumentsChain;
  * @augments StuffDocumentsChainInput
  */
 class MapReduceDocumentsChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "MapReduceDocumentsChain";
+    }
     get inputKeys() {
         return [this.inputKey, ...this.combineDocumentChain.inputKeys];
     }
@@ -238,6 +244,9 @@ exports.MapReduceDocumentsChain = MapReduceDocumentsChain;
  * @augments RefineDocumentsChainInput
  */
 class RefineDocumentsChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "RefineDocumentsChain";
+    }
     get defaultDocumentPrompt() {
         return new prompt_js_1.PromptTemplate({
             inputVariables: ["page_content"],

package/dist/chains/combine_docs_chain.d.ts

@@ -5,6 +5,9 @@ import { Document } from "../document.js";
 import { ChainValues } from "../schema/index.js";
 import { BasePromptTemplate } from "../prompts/base.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
+/**
+ * Interface for the input properties of the StuffDocumentsChain class.
+ */
 export interface StuffDocumentsChainInput extends ChainInputs {
     /** LLM Wrapper to use after formatting documents */
     llmChain: LLMChain;
@@ -18,6 +21,7 @@ export interface StuffDocumentsChainInput extends ChainInputs {
  * @augments StuffDocumentsChainInput
  */
 export declare class StuffDocumentsChain extends BaseChain implements StuffDocumentsChainInput {
+    static lc_name(): string;
     llmChain: LLMChain;
     inputKey: string;
     documentVariableName: string;
@@ -32,6 +36,10 @@ export declare class StuffDocumentsChain extends BaseChain implements StuffDocum
     static deserialize(data: SerializedStuffDocumentsChain): Promise<StuffDocumentsChain>;
     serialize(): SerializedStuffDocumentsChain;
 }
+/**
+ * Interface for the input properties of the MapReduceDocumentsChain
+ * class.
+ */
 export interface MapReduceDocumentsChainInput extends StuffDocumentsChainInput {
     /** The maximum number of tokens before requiring to do the reduction */
     maxTokens?: number;
@@ -50,6 +58,7 @@ export interface MapReduceDocumentsChainInput extends StuffDocumentsChainInput {
  * @augments StuffDocumentsChainInput
  */
 export declare class MapReduceDocumentsChain extends BaseChain implements MapReduceDocumentsChainInput {
+    static lc_name(): string;
     llmChain: LLMChain;
     inputKey: string;
     documentVariableName: string;
@@ -67,6 +76,9 @@ export declare class MapReduceDocumentsChain extends BaseChain implements MapRed
     static deserialize(data: SerializedMapReduceDocumentsChain): Promise<MapReduceDocumentsChain>;
     serialize(): SerializedMapReduceDocumentsChain;
 }
+/**
+ * Interface for the input properties of the RefineDocumentsChain class.
+ */
 export interface RefineDocumentsChainInput extends StuffDocumentsChainInput {
     refineLLMChain: LLMChain;
     documentPrompt?: BasePromptTemplate;
@@ -80,6 +92,7 @@ export interface RefineDocumentsChainInput extends StuffDocumentsChainInput {
  * @augments RefineDocumentsChainInput
  */
 export declare class RefineDocumentsChain extends BaseChain implements RefineDocumentsChainInput {
+    static lc_name(): string;
     llmChain: LLMChain;
     inputKey: string;
     outputKey: string;

package/dist/chains/combine_docs_chain.js

@@ -7,6 +7,9 @@ import { PromptTemplate } from "../prompts/prompt.js";
  * @augments StuffDocumentsChainInput
  */
 export class StuffDocumentsChain extends BaseChain {
+    static lc_name() {
+        return "StuffDocumentsChain";
+    }
     get inputKeys() {
         return [this.inputKey, ...this.llmChain.inputKeys].filter((key) => key !== this.documentVariableName);
     }
@@ -80,6 +83,9 @@ export class StuffDocumentsChain extends BaseChain {
  * @augments StuffDocumentsChainInput
  */
 export class MapReduceDocumentsChain extends BaseChain {
+    static lc_name() {
+        return "MapReduceDocumentsChain";
+    }
     get inputKeys() {
         return [this.inputKey, ...this.combineDocumentChain.inputKeys];
     }
@@ -233,6 +239,9 @@ export class MapReduceDocumentsChain extends BaseChain {
  * @augments RefineDocumentsChainInput
  */
 export class RefineDocumentsChain extends BaseChain {
+    static lc_name() {
+        return "RefineDocumentsChain";
+    }
     get defaultDocumentPrompt() {
         return new PromptTemplate({
             inputVariables: ["page_content"],

package/dist/chains/constitutional_ai/constitutional_chain.cjs

@@ -5,7 +5,14 @@ const base_js_1 = require("../base.cjs");
 const llm_chain_js_1 = require("../llm_chain.cjs");
 const constitutional_principle_js_1 = require("./constitutional_principle.cjs");
 const constitutional_prompts_js_1 = require("./constitutional_prompts.cjs");
+/**
+ * Class representing a ConstitutionalChain. Extends BaseChain and
+ * implements ConstitutionalChainInput.
+ */
 class ConstitutionalChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "ConstitutionalChain";
+    }
     get inputKeys() {
         return this.chain.inputKeys;
     }
@@ -66,12 +73,25 @@ class ConstitutionalChain extends base_js_1.BaseChain {
             output: response,
         };
     }
+    /**
+     * Static method that returns an array of ConstitutionalPrinciple objects
+     * based on the provided names.
+     * @param names Optional array of principle names.
+     * @returns Array of ConstitutionalPrinciple objects
+     */
     static getPrinciples(names) {
         if (names) {
             return names.map((name) => constitutional_principle_js_1.PRINCIPLES[name]);
         }
         return Object.values(constitutional_principle_js_1.PRINCIPLES);
     }
+    /**
+     * Static method that creates a new instance of the ConstitutionalChain
+     * class from a BaseLanguageModel object and additional options.
+     * @param llm BaseLanguageModel instance.
+     * @param options Options for the ConstitutionalChain.
+     * @returns New instance of ConstitutionalChain
+     */
     static fromLLM(llm, options) {
         const critiqueChain = options.critiqueChain ??
             new llm_chain_js_1.LLMChain({

package/dist/chains/constitutional_ai/constitutional_chain.d.ts

@@ -5,13 +5,21 @@ import { BaseChain, ChainInputs } from "../base.js";
 import { LLMChain } from "../llm_chain.js";
 import { SerializedBaseChain } from "../serde.js";
 import { ConstitutionalPrinciple } from "./constitutional_principle.js";
+/**
+ * Interface for the input of a ConstitutionalChain. Extends ChainInputs.
+ */
 export interface ConstitutionalChainInput extends ChainInputs {
     chain: LLMChain;
     constitutionalPrinciples: ConstitutionalPrinciple[];
     critiqueChain: LLMChain;
     revisionChain: LLMChain;
 }
+/**
+ * Class representing a ConstitutionalChain. Extends BaseChain and
+ * implements ConstitutionalChainInput.
+ */
 export declare class ConstitutionalChain extends BaseChain implements ConstitutionalChainInput {
+    static lc_name(): string;
     chain: LLMChain;
     constitutionalPrinciples: ConstitutionalPrinciple[];
     critiqueChain: LLMChain;
@@ -20,7 +28,20 @@ export declare class ConstitutionalChain extends BaseChain implements Constituti
     get outputKeys(): string[];
     constructor(fields: ConstitutionalChainInput);
     _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
+    /**
+     * Static method that returns an array of ConstitutionalPrinciple objects
+     * based on the provided names.
+     * @param names Optional array of principle names.
+     * @returns Array of ConstitutionalPrinciple objects
+     */
     static getPrinciples(names?: string[]): ConstitutionalPrinciple[];
+    /**
+     * Static method that creates a new instance of the ConstitutionalChain
+     * class from a BaseLanguageModel object and additional options.
+     * @param llm BaseLanguageModel instance.
+     * @param options Options for the ConstitutionalChain.
+     * @returns New instance of ConstitutionalChain
+     */
     static fromLLM(llm: BaseLanguageModel, options: Omit<ConstitutionalChainInput, "critiqueChain" | "revisionChain"> & {
         critiqueChain?: LLMChain;
         revisionChain?: LLMChain;

package/dist/chains/constitutional_ai/constitutional_chain.js

@@ -2,7 +2,14 @@ import { BaseChain } from "../base.js";
 import { LLMChain } from "../llm_chain.js";
 import { PRINCIPLES, } from "./constitutional_principle.js";
 import { CRITIQUE_PROMPT, REVISION_PROMPT } from "./constitutional_prompts.js";
+/**
+ * Class representing a ConstitutionalChain. Extends BaseChain and
+ * implements ConstitutionalChainInput.
+ */
 export class ConstitutionalChain extends BaseChain {
+    static lc_name() {
+        return "ConstitutionalChain";
+    }
     get inputKeys() {
         return this.chain.inputKeys;
     }
@@ -63,12 +70,25 @@ export class ConstitutionalChain extends BaseChain {
             output: response,
         };
     }
+    /**
+     * Static method that returns an array of ConstitutionalPrinciple objects
+     * based on the provided names.
+     * @param names Optional array of principle names.
+     * @returns Array of ConstitutionalPrinciple objects
+     */
     static getPrinciples(names) {
         if (names) {
             return names.map((name) => PRINCIPLES[name]);
         }
         return Object.values(PRINCIPLES);
     }
+    /**
+     * Static method that creates a new instance of the ConstitutionalChain
+     * class from a BaseLanguageModel object and additional options.
+     * @param llm BaseLanguageModel instance.
+     * @param options Options for the ConstitutionalChain.
+     * @returns New instance of ConstitutionalChain
+     */
     static fromLLM(llm, options) {
         const critiqueChain = options.critiqueChain ??
             new LLMChain({

package/dist/chains/constitutional_ai/constitutional_principle.cjs

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PRINCIPLES = exports.ConstitutionalPrinciple = void 0;
+/**
+ * Class representing a constitutional principle with critique request,
+ * revision request, and name properties.
+ */
 class ConstitutionalPrinciple {
     constructor({ critiqueRequest, revisionRequest, name, }) {
         Object.defineProperty(this, "critiqueRequest", {

package/dist/chains/constitutional_ai/constitutional_principle.d.ts

@@ -1,4 +1,8 @@
 import { SerializedConstitutionalPrinciple } from "../serde.js";
+/**
+ * Class representing a constitutional principle with critique request,
+ * revision request, and name properties.
+ */
 export declare class ConstitutionalPrinciple {
     critiqueRequest: string;
     revisionRequest: string;

package/dist/chains/constitutional_ai/constitutional_principle.js

@@ -1,3 +1,7 @@
+/**
+ * Class representing a constitutional principle with critique request,
+ * revision request, and name properties.
+ */
 export class ConstitutionalPrinciple {
     constructor({ critiqueRequest, revisionRequest, name, }) {
         Object.defineProperty(this, "critiqueRequest", {

package/dist/chains/conversation.cjs

@@ -10,7 +10,14 @@ Current conversation:
 {history}
 Human: {input}
 AI:`;
+/**
+ * A class for conducting conversations between a human and an AI. It
+ * extends the {@link LLMChain} class.
+ */
 class ConversationChain extends llm_chain_js_1.LLMChain {
+    static lc_name() {
+        return "ConversationChain";
+    }
     constructor({ prompt, outputKey, memory, ...rest }) {
         super({
             prompt: prompt ??

package/dist/chains/conversation.d.ts

@@ -1,6 +1,11 @@
 import { LLMChain, LLMChainInput } from "./llm_chain.js";
 import { Optional } from "../types/type-utils.js";
 export declare const DEFAULT_TEMPLATE = "The following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.\n\nCurrent conversation:\n{history}\nHuman: {input}\nAI:";
+/**
+ * A class for conducting conversations between a human and an AI. It
+ * extends the {@link LLMChain} class.
+ */
 export declare class ConversationChain extends LLMChain {
+    static lc_name(): string;
     constructor({ prompt, outputKey, memory, ...rest }: Optional<LLMChainInput, "prompt">);
 }

package/dist/chains/conversation.js

@@ -7,7 +7,14 @@ Current conversation:
 {history}
 Human: {input}
 AI:`;
+/**
+ * A class for conducting conversations between a human and an AI. It
+ * extends the {@link LLMChain} class.
+ */
 export class ConversationChain extends LLMChain {
+    static lc_name() {
+        return "ConversationChain";
+    }
     constructor({ prompt, outputKey, memory, ...rest }) {
         super({
             prompt: prompt ??

package/dist/chains/conversational_retrieval_chain.cjs

@@ -12,7 +12,15 @@ Chat History:
 {chat_history}
 Follow Up Input: {question}
 Standalone question:`;
+/**
+ * Class for conducting conversational question-answering tasks with a
+ * retrieval component. Extends the BaseChain class and implements the
+ * ConversationalRetrievalQAChainInput interface.
+ */
 class ConversationalRetrievalQAChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "ConversationalRetrievalQAChain";
+    }
     get inputKeys() {
         return [this.inputKey, this.chatHistoryKey];
     }
@@ -64,6 +72,12 @@ class ConversationalRetrievalQAChain extends base_js_1.BaseChain {
         this.returnSourceDocuments =
             fields.returnSourceDocuments ?? this.returnSourceDocuments;
     }
+    /**
+     * Static method to convert the chat history input into a formatted
+     * string.
+     * @param chatHistory Chat history input which can be a string, an array of BaseMessage instances, or an array of string arrays.
+     * @returns A formatted string representing the chat history.
+     */
     static getChatHistoryString(chatHistory) {
         let historyMessages;
         if (Array.isArray(chatHistory)) {
@@ -147,6 +161,16 @@ class ConversationalRetrievalQAChain extends base_js_1.BaseChain {
     serialize() {
         throw new Error("Not implemented.");
     }
+    /**
+     * Static method to create a new ConversationalRetrievalQAChain from a
+     * BaseLanguageModel and a BaseRetriever.
+     * @param llm {@link BaseLanguageModel} instance used to generate a new question.
+     * @param retriever {@link BaseRetriever} instance used to retrieve relevant documents.
+     * @param options.returnSourceDocuments Whether to return source documents in the final output
+     * @param options.questionGeneratorChainOptions Options to initialize the standalone question generation chain used as the first internal step
+     * @param options.qaChainOptions {@link QAChainParams} used to initialize the QA chain used as the second internal step
+     * @returns A new instance of ConversationalRetrievalQAChain.
+     */
     static fromLLM(llm, retriever, options = {}) {
         const { questionGeneratorTemplate, qaTemplate, qaChainOptions = {
             type: "stuff",

package/dist/chains/conversational_retrieval_chain.d.ts

@@ -7,6 +7,10 @@ import { LLMChain } from "./llm_chain.js";
 import { QAChainParams } from "./question_answering/load.js";
 import { CallbackManagerForChainRun } from "../callbacks/manager.js";
 export type LoadValues = Record<string, any>;
+/**
+ * Interface for the input parameters of the
+ * ConversationalRetrievalQAChain class.
+ */
 export interface ConversationalRetrievalQAChainInput extends ChainInputs {
     retriever: BaseRetriever;
     combineDocumentsChain: BaseChain;
@@ -14,7 +18,13 @@ export interface ConversationalRetrievalQAChainInput extends ChainInputs {
     returnSourceDocuments?: boolean;
     inputKey?: string;
 }
+/**
+ * Class for conducting conversational question-answering tasks with a
+ * retrieval component. Extends the BaseChain class and implements the
+ * ConversationalRetrievalQAChainInput interface.
+ */
 export declare class ConversationalRetrievalQAChain extends BaseChain implements ConversationalRetrievalQAChainInput {
+    static lc_name(): string;
     inputKey: string;
     chatHistoryKey: string;
     get inputKeys(): string[];
@@ -24,12 +34,28 @@ export declare class ConversationalRetrievalQAChain extends BaseChain implements
     questionGeneratorChain: LLMChain;
     returnSourceDocuments: boolean;
     constructor(fields: ConversationalRetrievalQAChainInput);
+    /**
+     * Static method to convert the chat history input into a formatted
+     * string.
+     * @param chatHistory Chat history input which can be a string, an array of BaseMessage instances, or an array of string arrays.
+     * @returns A formatted string representing the chat history.
+     */
     static getChatHistoryString(chatHistory: string | BaseMessage[] | string[][]): string;
     /** @ignore */
     _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
     _chainType(): string;
     static deserialize(_data: SerializedChatVectorDBQAChain, _values: LoadValues): Promise<ConversationalRetrievalQAChain>;
     serialize(): SerializedChatVectorDBQAChain;
+    /**
+     * Static method to create a new ConversationalRetrievalQAChain from a
+     * BaseLanguageModel and a BaseRetriever.
+     * @param llm {@link BaseLanguageModel} instance used to generate a new question.
+     * @param retriever {@link BaseRetriever} instance used to retrieve relevant documents.
+     * @param options.returnSourceDocuments Whether to return source documents in the final output
+     * @param options.questionGeneratorChainOptions Options to initialize the standalone question generation chain used as the first internal step
+     * @param options.qaChainOptions {@link QAChainParams} used to initialize the QA chain used as the second internal step
+     * @returns A new instance of ConversationalRetrievalQAChain.
+     */
     static fromLLM(llm: BaseLanguageModel, retriever: BaseRetriever, options?: {
         outputKey?: string;
         returnSourceDocuments?: boolean;
@@ -37,10 +63,10 @@ export declare class ConversationalRetrievalQAChain extends BaseChain implements
         questionGeneratorTemplate?: string;
         /** @deprecated Pass in qaChainOptions.prompt instead */
         qaTemplate?: string;
-        qaChainOptions?: QAChainParams;
         questionGeneratorChainOptions?: {
             llm?: BaseLanguageModel;
             template?: string;
         };
+        qaChainOptions?: QAChainParams;
     } & Omit<ConversationalRetrievalQAChainInput, "retriever" | "combineDocumentsChain" | "questionGeneratorChain">): ConversationalRetrievalQAChain;
 }