langchain 0.0.130 → 0.0.132

package/dist/chains/conversational_retrieval_chain.js

@@ -9,7 +9,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.
+ */
 export class ConversationalRetrievalQAChain extends BaseChain {
+    static lc_name() {
+        return "ConversationalRetrievalQAChain";
+    }
     get inputKeys() {
         return [this.inputKey, this.chatHistoryKey];
     }
@@ -61,6 +69,12 @@ export class ConversationalRetrievalQAChain extends 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)) {
@@ -144,6 +158,16 @@ export class ConversationalRetrievalQAChain extends 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/llm_chain.cjs

@@ -19,6 +19,9 @@ const noop_js_1 = require("../output_parsers/noop.cjs");
  * ```
  */
 class LLMChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "LLMChain";
+    }
     get inputKeys() {
         return this.prompt.inputVariables;
     }

package/dist/chains/llm_chain.d.ts

@@ -6,6 +6,9 @@ import { BaseLLMOutputParser } from "../schema/output_parser.js";
 import { SerializedLLMChain } from "./serde.js";
 import { CallbackManager } from "../callbacks/index.js";
 import { BaseCallbackConfig, CallbackManagerForChainRun, Callbacks } from "../callbacks/manager.js";
+/**
+ * Interface for the input parameters of the LLMChain class.
+ */
 export interface LLMChainInput<T extends string | object = string, L extends BaseLanguageModel = BaseLanguageModel> extends ChainInputs {
     /** Prompt object to use */
     prompt: BasePromptTemplate;
@@ -32,6 +35,7 @@ export interface LLMChainInput<T extends string | object = string, L extends Bas
  * ```
  */
 export declare class LLMChain<T extends string | object = string, L extends BaseLanguageModel = BaseLanguageModel> extends BaseChain implements LLMChainInput<T> {
+    static lc_name(): string;
     lc_serializable: boolean;
     prompt: BasePromptTemplate;
     llm: L;

package/dist/chains/llm_chain.js

@@ -16,6 +16,9 @@ import { NoOpOutputParser } from "../output_parsers/noop.js";
  * ```
  */
 export class LLMChain extends BaseChain {
+    static lc_name() {
+        return "LLMChain";
+    }
     get inputKeys() {
         return this.prompt.inputVariables;
     }

package/dist/chains/openai_functions/extraction.cjs

@@ -5,6 +5,12 @@ const zod_to_json_schema_1 = require("zod-to-json-schema");
 const prompt_js_1 = require("../../prompts/prompt.cjs");
 const openai_functions_js_1 = require("../../output_parsers/openai_functions.cjs");
 const llm_chain_js_1 = require("../llm_chain.cjs");
+/**
+ * Function that returns an array of extraction functions. These functions
+ * are used to extract relevant information from a passage.
+ * @param schema The schema of the function parameters.
+ * @returns An array of extraction functions.
+ */
 function getExtractionFunctions(schema) {
     return [
         {
@@ -32,6 +38,13 @@ const _EXTRACTION_TEMPLATE = `Extract and save the relevant entities mentioned i
 Passage:
 {input}
 `;
+/**
+ * Function that creates an extraction chain using the provided JSON schema.
+ * It sets up the necessary components, such as the prompt, output parser, and tags.
+ * @param schema JSON schema of the function parameters.
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 function createExtractionChain(schema, llm) {
     const functions = getExtractionFunctions(schema);
     const prompt = prompt_js_1.PromptTemplate.fromTemplate(_EXTRACTION_TEMPLATE);
@@ -45,6 +58,14 @@ function createExtractionChain(schema, llm) {
     });
 }
 exports.createExtractionChain = createExtractionChain;
+/**
+ * Function that creates an extraction chain from a Zod schema. It
+ * converts the Zod schema to a JSON schema using zod-to-json-schema
+ * before creating the extraction chain.
+ * @param schema The Zod schema which extracted data should match
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 function createExtractionChainFromZod(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 schema, llm) {

package/dist/chains/openai_functions/extraction.d.ts

@@ -2,5 +2,20 @@ import { z } from "zod";
 import { ChatOpenAI } from "../../chat_models/openai.js";
 import { FunctionParameters } from "../../output_parsers/openai_functions.js";
 import { LLMChain } from "../llm_chain.js";
+/**
+ * Function that creates an extraction chain using the provided JSON schema.
+ * It sets up the necessary components, such as the prompt, output parser, and tags.
+ * @param schema JSON schema of the function parameters.
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 export declare function createExtractionChain(schema: FunctionParameters, llm: ChatOpenAI): LLMChain<object, ChatOpenAI>;
+/**
+ * Function that creates an extraction chain from a Zod schema. It
+ * converts the Zod schema to a JSON schema using zod-to-json-schema
+ * before creating the extraction chain.
+ * @param schema The Zod schema which extracted data should match
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 export declare function createExtractionChainFromZod(schema: z.ZodObject<any, any, any, any>, llm: ChatOpenAI): LLMChain<object, ChatOpenAI>;

package/dist/chains/openai_functions/extraction.js

@@ -2,6 +2,12 @@ import { zodToJsonSchema } from "zod-to-json-schema";
 import { PromptTemplate } from "../../prompts/prompt.js";
 import { JsonKeyOutputFunctionsParser, } from "../../output_parsers/openai_functions.js";
 import { LLMChain } from "../llm_chain.js";
+/**
+ * Function that returns an array of extraction functions. These functions
+ * are used to extract relevant information from a passage.
+ * @param schema The schema of the function parameters.
+ * @returns An array of extraction functions.
+ */
 function getExtractionFunctions(schema) {
     return [
         {
@@ -29,6 +35,13 @@ const _EXTRACTION_TEMPLATE = `Extract and save the relevant entities mentioned i
 Passage:
 {input}
 `;
+/**
+ * Function that creates an extraction chain using the provided JSON schema.
+ * It sets up the necessary components, such as the prompt, output parser, and tags.
+ * @param schema JSON schema of the function parameters.
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 export function createExtractionChain(schema, llm) {
     const functions = getExtractionFunctions(schema);
     const prompt = PromptTemplate.fromTemplate(_EXTRACTION_TEMPLATE);
@@ -41,6 +54,14 @@ export function createExtractionChain(schema, llm) {
         tags: ["openai_functions", "extraction"],
     });
 }
+/**
+ * Function that creates an extraction chain from a Zod schema. It
+ * converts the Zod schema to a JSON schema using zod-to-json-schema
+ * before creating the extraction chain.
+ * @param schema The Zod schema which extracted data should match
+ * @param llm Must be a ChatOpenAI model that supports function calling.
+ * @returns A LLMChain instance configured to return data matching the schema.
+ */
 export function createExtractionChainFromZod(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 schema, llm) {

package/dist/chains/openai_functions/openapi.cjs

@@ -8,6 +8,13 @@ const openai_js_1 = require("../../chat_models/openai.cjs");
 const chat_js_1 = require("../../prompts/chat.cjs");
 const sequential_chain_js_1 = require("../sequential_chain.cjs");
 const openai_functions_js_1 = require("../../output_parsers/openai_functions.cjs");
+/**
+ * Formats a URL by replacing path parameters with their corresponding
+ * values.
+ * @param url The URL to format.
+ * @param pathParams The path parameters to replace in the URL.
+ * @returns The formatted URL.
+ */
 function formatURL(url, pathParams) {
     const expectedPathParamNames = [...url.matchAll(/{(.*?)}/g)].map((match) => match[1]);
     const newParams = {};
@@ -65,6 +72,12 @@ function formatURL(url, pathParams) {
     }
     return formattedUrl;
 }
+/**
+ * Converts OpenAPI parameters to JSON schema format.
+ * @param params The OpenAPI parameters to convert.
+ * @param spec The OpenAPI specification that contains the parameters.
+ * @returns The JSON schema representation of the OpenAPI parameters.
+ */
 function convertOpenAPIParamsToJSONSchema(params, spec) {
     return params.reduce((jsonSchema, param) => {
         let schema;
@@ -102,6 +115,12 @@ function convertOpenAPIParamsToJSONSchema(params, spec) {
     });
 }
 // OpenAI throws errors on extraneous schema properties, e.g. if "required" is set on individual ones
+/**
+ * Converts OpenAPI schemas to JSON schema format.
+ * @param schema The OpenAPI schema to convert.
+ * @param spec The OpenAPI specification that contains the schema.
+ * @returns The JSON schema representation of the OpenAPI schema.
+ */
 function convertOpenAPISchemaToJSONSchema(schema, spec) {
     if (schema.type !== "object" && schema.type !== "array") {
         return {
@@ -133,6 +152,11 @@ function convertOpenAPISchemaToJSONSchema(schema, spec) {
         additionalProperties: {},
     });
 }
+/**
+ * Converts an OpenAPI specification to OpenAI functions.
+ * @param spec The OpenAPI specification to convert.
+ * @returns An object containing the OpenAI functions derived from the OpenAPI specification and a default execution method.
+ */
 function convertOpenAPISpecToOpenAIFunctions(spec) {
     if (!spec.document.paths) {
         return { openAIFunctions: [] };
@@ -271,7 +295,13 @@ function convertOpenAPISpecToOpenAIFunctions(spec) {
         },
     };
 }
+/**
+ * A chain for making simple API requests.
+ */
 class SimpleRequestChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "SimpleRequestChain";
+    }
     constructor(config) {
         super();
         Object.defineProperty(this, "requestMethod", {

package/dist/chains/openai_functions/openapi.d.ts

@@ -4,6 +4,9 @@ import { LLMChainInput } from "../llm_chain.js";
 import { ChatOpenAI } from "../../chat_models/openai.js";
 import { BasePromptTemplate } from "../../prompts/base.js";
 import { SequentialChain } from "../sequential_chain.js";
+/**
+ * Type representing the options for creating an OpenAPI chain.
+ */
 export type OpenAPIChainOptions = {
     llm?: ChatOpenAI;
     prompt?: BasePromptTemplate;

package/dist/chains/openai_functions/openapi.js

@@ -5,6 +5,13 @@ import { ChatOpenAI } from "../../chat_models/openai.js";
 import { ChatPromptTemplate, HumanMessagePromptTemplate, } from "../../prompts/chat.js";
 import { SequentialChain } from "../sequential_chain.js";
 import { JsonOutputFunctionsParser } from "../../output_parsers/openai_functions.js";
+/**
+ * Formats a URL by replacing path parameters with their corresponding
+ * values.
+ * @param url The URL to format.
+ * @param pathParams The path parameters to replace in the URL.
+ * @returns The formatted URL.
+ */
 function formatURL(url, pathParams) {
     const expectedPathParamNames = [...url.matchAll(/{(.*?)}/g)].map((match) => match[1]);
     const newParams = {};
@@ -62,6 +69,12 @@ function formatURL(url, pathParams) {
     }
     return formattedUrl;
 }
+/**
+ * Converts OpenAPI parameters to JSON schema format.
+ * @param params The OpenAPI parameters to convert.
+ * @param spec The OpenAPI specification that contains the parameters.
+ * @returns The JSON schema representation of the OpenAPI parameters.
+ */
 function convertOpenAPIParamsToJSONSchema(params, spec) {
     return params.reduce((jsonSchema, param) => {
         let schema;
@@ -99,6 +112,12 @@ function convertOpenAPIParamsToJSONSchema(params, spec) {
     });
 }
 // OpenAI throws errors on extraneous schema properties, e.g. if "required" is set on individual ones
+/**
+ * Converts OpenAPI schemas to JSON schema format.
+ * @param schema The OpenAPI schema to convert.
+ * @param spec The OpenAPI specification that contains the schema.
+ * @returns The JSON schema representation of the OpenAPI schema.
+ */
 function convertOpenAPISchemaToJSONSchema(schema, spec) {
     if (schema.type !== "object" && schema.type !== "array") {
         return {
@@ -130,6 +149,11 @@ function convertOpenAPISchemaToJSONSchema(schema, spec) {
         additionalProperties: {},
     });
 }
+/**
+ * Converts an OpenAPI specification to OpenAI functions.
+ * @param spec The OpenAPI specification to convert.
+ * @returns An object containing the OpenAI functions derived from the OpenAPI specification and a default execution method.
+ */
 function convertOpenAPISpecToOpenAIFunctions(spec) {
     if (!spec.document.paths) {
         return { openAIFunctions: [] };
@@ -268,7 +292,13 @@ function convertOpenAPISpecToOpenAIFunctions(spec) {
         },
     };
 }
+/**
+ * A chain for making simple API requests.
+ */
 class SimpleRequestChain extends BaseChain {
+    static lc_name() {
+        return "SimpleRequestChain";
+    }
     constructor(config) {
         super();
         Object.defineProperty(this, "requestMethod", {

package/dist/chains/openai_functions/structured_output.cjs

@@ -7,6 +7,10 @@ const llm_chain_js_1 = require("../llm_chain.cjs");
 const openai_js_1 = require("../../chat_models/openai.cjs");
 const output_parser_js_1 = require("../../schema/output_parser.cjs");
 const openai_functions_js_1 = require("../../output_parsers/openai_functions.cjs");
+/**
+ * Class that extends the BaseLLMOutputParser class. It provides
+ * functionality for parsing the structured output based on a JSON schema.
+ */
 class FunctionCallStructuredOutputParser extends output_parser_js_1.BaseLLMOutputParser {
     constructor(schema) {
         super();
@@ -36,6 +40,14 @@ class FunctionCallStructuredOutputParser extends output_parser_js_1.BaseLLMOutpu
         });
         this.jsonSchemaValidator = new index_js_1.Validator(schema, "7");
     }
+    /**
+     * Method to parse the result of chat generations. It first parses the
+     * result using the functionOutputParser, then validates the parsed result
+     * against the JSON schema. If the result is valid, it returns the parsed
+     * result. Otherwise, it throws an OutputParserException.
+     * @param generations Array of ChatGeneration instances to be parsed.
+     * @returns The parsed result if it is valid according to the JSON schema.
+     */
     async parseResult(generations) {
         const initialResult = await this.functionOutputParser.parseResult(generations);
         const parsedResult = JSON.parse(initialResult, (_, value) => {

package/dist/chains/openai_functions/structured_output.d.ts

@@ -7,17 +7,35 @@ import { BasePromptTemplate } from "../../prompts/index.js";
 import { BaseLLMOutputParser } from "../../schema/output_parser.js";
 import { OutputFunctionsParser } from "../../output_parsers/openai_functions.js";
 import { ChatGeneration } from "../../schema/index.js";
+/**
+ * Type representing the input for creating a structured output chain. It
+ * extends the LLMChainInput type and includes an additional
+ * 'outputSchema' field representing the JSON schema for the expected
+ * output.
+ */
 export type StructuredOutputChainInput = Omit<LLMChainInput, "outputParser" | "llm"> & {
     outputSchema: JsonSchema7Type;
     prompt: BasePromptTemplate;
     llm?: ChatOpenAI;
 };
+/**
+ * Class that extends the BaseLLMOutputParser class. It provides
+ * functionality for parsing the structured output based on a JSON schema.
+ */
 export declare class FunctionCallStructuredOutputParser<T extends z.AnyZodObject> extends BaseLLMOutputParser<z.infer<T>> {
     schema: JsonSchema7Type;
     lc_namespace: string[];
     protected functionOutputParser: OutputFunctionsParser;
     protected jsonSchemaValidator: Validator;
     constructor(schema: JsonSchema7Type);
+    /**
+     * Method to parse the result of chat generations. It first parses the
+     * result using the functionOutputParser, then validates the parsed result
+     * against the JSON schema. If the result is valid, it returns the parsed
+     * result. Otherwise, it throws an OutputParserException.
+     * @param generations Array of ChatGeneration instances to be parsed.
+     * @returns The parsed result if it is valid according to the JSON schema.
+     */
     parseResult(generations: ChatGeneration[]): Promise<any>;
 }
 /**

package/dist/chains/openai_functions/structured_output.js

@@ -4,6 +4,10 @@ import { LLMChain } from "../llm_chain.js";
 import { ChatOpenAI } from "../../chat_models/openai.js";
 import { BaseLLMOutputParser, OutputParserException, } from "../../schema/output_parser.js";
 import { OutputFunctionsParser } from "../../output_parsers/openai_functions.js";
+/**
+ * Class that extends the BaseLLMOutputParser class. It provides
+ * functionality for parsing the structured output based on a JSON schema.
+ */
 export class FunctionCallStructuredOutputParser extends BaseLLMOutputParser {
     constructor(schema) {
         super();
@@ -33,6 +37,14 @@ export class FunctionCallStructuredOutputParser extends BaseLLMOutputParser {
         });
         this.jsonSchemaValidator = new Validator(schema, "7");
     }
+    /**
+     * Method to parse the result of chat generations. It first parses the
+     * result using the functionOutputParser, then validates the parsed result
+     * against the JSON schema. If the result is valid, it returns the parsed
+     * result. Otherwise, it throws an OutputParserException.
+     * @param generations Array of ChatGeneration instances to be parsed.
+     * @returns The parsed result if it is valid according to the JSON schema.
+     */
     async parseResult(generations) {
         const initialResult = await this.functionOutputParser.parseResult(generations);
         const parsedResult = JSON.parse(initialResult, (_, value) => {

package/dist/chains/openai_functions/tagging.cjs

@@ -5,6 +5,12 @@ const zod_to_json_schema_1 = require("zod-to-json-schema");
 const prompt_js_1 = require("../../prompts/prompt.cjs");
 const openai_functions_js_1 = require("../../output_parsers/openai_functions.cjs");
 const llm_chain_js_1 = require("../llm_chain.cjs");
+/**
+ * Function that returns an array of tagging functions. These functions
+ * are used to extract relevant information from a passage.
+ * @param schema The schema defining the structure of function parameters.
+ * @returns An array of tagging functions.
+ */
 function getTaggingFunctions(schema) {
     return [
         {
@@ -19,6 +25,15 @@ const TAGGING_TEMPLATE = `Extract the desired information from the following pas
 Passage:
 {input}
 `;
+/**
+ * Function that creates a tagging chain using the provided schema,
+ * LLM, and options. It constructs the LLM with the necessary
+ * functions, prompt, output parser, and tags.
+ * @param schema The schema defining the structure of function parameters.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 function createTaggingChain(schema, llm, options = {}) {
     const { prompt = prompt_js_1.PromptTemplate.fromTemplate(TAGGING_TEMPLATE), ...rest } = options;
     const functions = getTaggingFunctions(schema);
@@ -33,6 +48,15 @@ function createTaggingChain(schema, llm, options = {}) {
     });
 }
 exports.createTaggingChain = createTaggingChain;
+/**
+ * Function that creates a tagging chain from a Zod schema. It converts
+ * the Zod schema to a JSON schema using the zodToJsonSchema function and
+ * then calls createTaggingChain with the converted schema.
+ * @param schema The Zod schema which extracted data should match.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 function createTaggingChainFromZod(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 schema, llm, options) {

package/dist/chains/openai_functions/tagging.d.ts

@@ -3,8 +3,29 @@ import { ChatOpenAI } from "../../chat_models/openai.js";
 import { PromptTemplate } from "../../prompts/prompt.js";
 import { FunctionParameters } from "../../output_parsers/openai_functions.js";
 import { LLMChain, LLMChainInput } from "../llm_chain.js";
+/**
+ * Type representing the options for creating a tagging chain.
+ */
 export type TaggingChainOptions = {
     prompt?: PromptTemplate;
 } & Omit<LLMChainInput<object>, "prompt" | "llm">;
+/**
+ * Function that creates a tagging chain using the provided schema,
+ * LLM, and options. It constructs the LLM with the necessary
+ * functions, prompt, output parser, and tags.
+ * @param schema The schema defining the structure of function parameters.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 export declare function createTaggingChain(schema: FunctionParameters, llm: ChatOpenAI, options?: TaggingChainOptions): LLMChain<object, ChatOpenAI>;
+/**
+ * Function that creates a tagging chain from a Zod schema. It converts
+ * the Zod schema to a JSON schema using the zodToJsonSchema function and
+ * then calls createTaggingChain with the converted schema.
+ * @param schema The Zod schema which extracted data should match.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 export declare function createTaggingChainFromZod(schema: z.ZodObject<any, any, any, any>, llm: ChatOpenAI, options?: TaggingChainOptions): LLMChain<object, ChatOpenAI>;

package/dist/chains/openai_functions/tagging.js

@@ -2,6 +2,12 @@ import { zodToJsonSchema } from "zod-to-json-schema";
 import { PromptTemplate } from "../../prompts/prompt.js";
 import { JsonOutputFunctionsParser, } from "../../output_parsers/openai_functions.js";
 import { LLMChain } from "../llm_chain.js";
+/**
+ * Function that returns an array of tagging functions. These functions
+ * are used to extract relevant information from a passage.
+ * @param schema The schema defining the structure of function parameters.
+ * @returns An array of tagging functions.
+ */
 function getTaggingFunctions(schema) {
     return [
         {
@@ -16,6 +22,15 @@ const TAGGING_TEMPLATE = `Extract the desired information from the following pas
 Passage:
 {input}
 `;
+/**
+ * Function that creates a tagging chain using the provided schema,
+ * LLM, and options. It constructs the LLM with the necessary
+ * functions, prompt, output parser, and tags.
+ * @param schema The schema defining the structure of function parameters.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 export function createTaggingChain(schema, llm, options = {}) {
     const { prompt = PromptTemplate.fromTemplate(TAGGING_TEMPLATE), ...rest } = options;
     const functions = getTaggingFunctions(schema);
@@ -29,6 +44,15 @@ export function createTaggingChain(schema, llm, options = {}) {
         ...rest,
     });
 }
+/**
+ * Function that creates a tagging chain from a Zod schema. It converts
+ * the Zod schema to a JSON schema using the zodToJsonSchema function and
+ * then calls createTaggingChain with the converted schema.
+ * @param schema The Zod schema which extracted data should match.
+ * @param llm LLM to use in the chain. Must support OpenAI function calling.
+ * @param options Options for creating the tagging chain.
+ * @returns A new instance of LLMChain configured for tagging.
+ */
 export function createTaggingChainFromZod(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 schema, llm, options) {

package/dist/chains/openai_moderation.cjs

@@ -9,7 +9,15 @@ const base_js_1 = require("./base.cjs");
 const axios_fetch_adapter_js_1 = __importDefault(require("../util/axios-fetch-adapter.cjs"));
 const async_caller_js_1 = require("../util/async_caller.cjs");
 const env_js_1 = require("../util/env.cjs");
+/**
+ * Class representing a chain for moderating text using the OpenAI
+ * Moderation API. It extends the BaseChain class and implements the
+ * OpenAIModerationChainInput interface.
+ */
 class OpenAIModerationChain extends base_js_1.BaseChain {
+    static lc_name() {
+        return "OpenAIModerationChain";
+    }
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",

package/dist/chains/openai_moderation.d.ts

@@ -2,13 +2,22 @@ import { Configuration, OpenAIApi, ConfigurationParameters, CreateModerationResp
 import { BaseChain, ChainInputs } from "./base.js";
 import { ChainValues } from "../schema/index.js";
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
+/**
+ * Interface for the input parameters of the OpenAIModerationChain class.
+ */
 export interface OpenAIModerationChainInput extends ChainInputs, AsyncCallerParams {
     openAIApiKey?: string;
     openAIOrganization?: string;
     throwError?: boolean;
     configuration?: ConfigurationParameters;
 }
+/**
+ * Class representing a chain for moderating text using the OpenAI
+ * Moderation API. It extends the BaseChain class and implements the
+ * OpenAIModerationChainInput interface.
+ */
 export declare class OpenAIModerationChain extends BaseChain implements OpenAIModerationChainInput {
+    static lc_name(): string;
     get lc_secrets(): {
         [key: string]: string;
     } | undefined;

package/dist/chains/openai_moderation.js

@@ -3,7 +3,15 @@ import { BaseChain } from "./base.js";
 import fetchAdapter from "../util/axios-fetch-adapter.js";
 import { AsyncCaller } from "../util/async_caller.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Class representing a chain for moderating text using the OpenAI
+ * Moderation API. It extends the BaseChain class and implements the
+ * OpenAIModerationChainInput interface.
+ */
 export class OpenAIModerationChain extends BaseChain {
+    static lc_name() {
+        return "OpenAIModerationChain";
+    }
     get lc_secrets() {
         return {
             openAIApiKey: "OPENAI_API_KEY",

package/dist/chains/query_constructor/index.cjs

@@ -24,6 +24,10 @@ const queryInputSchema = /* #__PURE__ */ zod_1.z.object({
         .optional()
         .describe("logical condition statement for filtering documents"),
 });
+/**
+ * A class that extends AsymmetricStructuredOutputParser to parse
+ * structured query output.
+ */
 class StructuredQueryOutputParser extends structured_js_1.AsymmetricStructuredOutputParser {
     constructor(fields) {
         super({ ...fields, inputSchema: queryInputSchema });
@@ -42,6 +46,12 @@ class StructuredQueryOutputParser extends structured_js_1.AsymmetricStructuredOu
         const { allowedComparators, allowedOperators } = fields;
         this.queryTransformer = new parser_js_1.QueryTransformer(allowedComparators, allowedOperators);
     }
+    /**
+     * Processes the output of a structured query.
+     * @param query The query string.
+     * @param filter The filter condition.
+     * @returns A Promise that resolves to a StructuredQuery instance.
+     */
     async outputProcessor({ query, filter, }) {
         let myQuery = query;
         if (myQuery.length === 0) {
@@ -55,6 +65,13 @@ class StructuredQueryOutputParser extends structured_js_1.AsymmetricStructuredOu
             return new ir_js_1.StructuredQuery(query, parsedFilter);
         }
     }
+    /**
+     * Creates a new StructuredQueryOutputParser instance from the provided
+     * components.
+     * @param allowedComparators An array of allowed Comparator instances.
+     * @param allowedOperators An array of allowed Operator instances.
+     * @returns A new StructuredQueryOutputParser instance.
+     */
     static fromComponents(allowedComparators = [], allowedOperators = []) {
         return new StructuredQueryOutputParser({
             allowedComparators,