langchain 0.0.131 → 0.0.132

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

@@ -5,12 +5,19 @@ 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;
@@ -21,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,6 +2,10 @@ 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";
@@ -66,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,6 +10,10 @@ 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";

package/dist/chains/conversation.d.ts

@@ -1,6 +1,10 @@
 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,6 +7,10 @@ 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";

package/dist/chains/conversational_retrieval_chain.cjs

@@ -12,6 +12,11 @@ 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";
@@ -67,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)) {
@@ -150,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,6 +18,11 @@ 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;
@@ -25,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;
@@ -38,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;
 }

package/dist/chains/conversational_retrieval_chain.js

@@ -9,6 +9,11 @@ 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";
@@ -64,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)) {
@@ -147,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.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;

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,6 +295,9 @@ function convertOpenAPISpecToOpenAIFunctions(spec) {
         },
     };
 }
+/**
+ * A chain for making simple API requests.
+ */
 class SimpleRequestChain extends base_js_1.BaseChain {
     static lc_name() {
         return "SimpleRequestChain";

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,6 +292,9 @@ function convertOpenAPISpecToOpenAIFunctions(spec) {
         },
     };
 }
+/**
+ * A chain for making simple API requests.
+ */
 class SimpleRequestChain extends BaseChain {
     static lc_name() {
         return "SimpleRequestChain";

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) => {