@langchain/classic 1.0.0-alpha.1

package/dist/chains/openai_functions/base.d.cts

@@ -0,0 +1,172 @@
+import { BaseMessage } from "@langchain/core/messages";
+import { Runnable, RunnableInterface } from "@langchain/core/runnables";
+import { BaseOutputParser } from "@langchain/core/output_parsers";
+import { InputValues, InteropZodObject } from "@langchain/core/utils/types";
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { BaseFunctionCallOptions, BaseLanguageModelInput, FunctionDefinition } from "@langchain/core/language_models/base";
+import { JsonSchema7Type } from "@langchain/core/utils/json_schema";
+
+//#region src/chains/openai_functions/base.d.ts
+
+/**
+ * Configuration params for the createOpenAIFnRunnable method.
+ */
+type CreateOpenAIFnRunnableConfig<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any>, RunOutput> = {
+  functions: FunctionDefinition[];
+  /** Language model to use, assumed to support the OpenAI function-calling API. */
+  llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;
+  /** BasePromptTemplate to pass to the model. */
+  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;
+  /**
+   * Only used if a single function is passed in. If `true`, then the model will be
+   * forced to use the given function. If `false`, then the model will be given the
+   * option to use the given function or not.
+   */
+  enforceSingleFunctionUsage?: boolean;
+  /**
+   * BaseLLMOutputParser to use for parsing model outputs.
+   * By default will be inferred from the function types.
+   */
+  outputParser?: BaseOutputParser<RunOutput>;
+};
+/**
+ * Creates a runnable sequence that calls OpenAI functions.
+ * @param config - The parameters required to create the runnable.
+ * @returns A runnable sequence that will pass the given functions to the model when run.
+ *
+ * @example
+ * ```typescript
+ * const openAIFunction = {
+ *   name: "get_person_details",
+ *   description: "Get details about a person",
+ *   parameters: {
+ *     title: "Person",
+ *     description: "Identifying information about a person.",
+ *     type: "object",
+ *     properties: {
+ *       name: { title: "Name", description: "The person's name", type: "string" },
+ *       age: { title: "Age", description: "The person's age", type: "integer" },
+ *       fav_food: {
+ *         title: "Fav Food",
+ *         description: "The person's favorite food",
+ *         type: "string",
+ *       },
+ *     },
+ *     required: ["name", "age"],
+ *   },
+ * };
+ *
+ * const model = new ChatOpenAI();
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["human", "Human description: {description}"],
+ * ]);
+ * const outputParser = new JsonOutputFunctionsParser();
+ *
+ * const runnable = createOpenAIFnRunnable({
+ *   functions: [openAIFunction],
+ *   llm: model,
+ *   prompt,
+ *   enforceSingleFunctionUsage: true, // Default is true
+ *   outputParser
+ * });
+ * const response = await runnable.invoke({
+ *   description:
+ *     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+ * });
+ *
+ * console.log(response);
+ *
+ * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+ * ```
+ */
+declare function createOpenAIFnRunnable<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any> = Record<string, any>,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunOutput extends Record<string, any> = Record<string, any>>(config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;
+/**
+ * Configuration params for the createStructuredOutputRunnable method.
+ */
+type CreateStructuredOutputRunnableConfig<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any>, RunOutput> = {
+  /**
+   * Schema to output. Must be either valid JSONSchema or a Zod schema.
+   */
+  outputSchema: InteropZodObject | JsonSchema7Type;
+  /**
+   * Language model to use, assumed to support the OpenAI function-calling API.
+   */
+  llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;
+  /** BasePromptTemplate to pass to the model. */
+  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;
+  /**
+   * BaseLLMOutputParser to use for parsing model outputs.
+   */
+  outputParser?: BaseOutputParser<RunOutput>;
+};
+/**
+ * @deprecated Prefer the `.withStructuredOutput` method on chat model classes.
+ *
+ * Create a runnable that uses an OpenAI function to get a structured output.
+ * @param config Params required to create the runnable.
+ * @returns A runnable sequence that will pass the given function to the model when run.
+ *
+ * @example
+ * ```typescript
+ * import { createStructuredOutputRunnable } from "@langchain/classic/chains/openai_functions";
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { ChatPromptTemplate } from "@langchain/core/prompts";
+ * import { JsonOutputFunctionsParser } from "@langchain/classic/output_parsers";
+ *
+ * const jsonSchema = {
+ *   title: "Person",
+ *   description: "Identifying information about a person.",
+ *   type: "object",
+ *   properties: {
+ *     name: { title: "Name", description: "The person's name", type: "string" },
+ *     age: { title: "Age", description: "The person's age", type: "integer" },
+ *     fav_food: {
+ *       title: "Fav Food",
+ *       description: "The person's favorite food",
+ *       type: "string",
+ *     },
+ *   },
+ *   required: ["name", "age"],
+ * };
+ *
+ * const model = new ChatOpenAI({ model: "gpt-4o-mini" });
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["human", "Human description: {description}"],
+ * ]);
+ *
+ * const outputParser = new JsonOutputFunctionsParser();
+ *
+ * // Also works with Zod schema
+ * const runnable = createStructuredOutputRunnable({
+ *   outputSchema: jsonSchema,
+ *   llm: model,
+ *   prompt,
+ *   outputParser
+ * });
+ *
+ * const response = await runnable.invoke({
+ *   description:
+ *     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+ * });
+ *
+ * console.log(response);
+ *
+ * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+ * ```
+ */
+declare function createStructuredOutputRunnable<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any> = Record<string, any>,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunOutput extends Record<string, any> = Record<string, any>>(config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;
+//#endregion
+export { CreateOpenAIFnRunnableConfig, CreateStructuredOutputRunnableConfig, createOpenAIFnRunnable, createStructuredOutputRunnable };
+//# sourceMappingURL=base.d.cts.map

package/dist/chains/openai_functions/base.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.cts","names":["BaseOutputParser","BasePromptTemplate","Runnable","RunnableInterface","BaseFunctionCallOptions","BaseLanguageModelInput","FunctionDefinition","InputValues","InteropZodObject","BaseMessage","JsonSchema7Type","CreateOpenAIFnRunnableConfig","Record","RunInput","Extract","RunOutput","createOpenAIFnRunnable","CreateStructuredOutputRunnableConfig","createStructuredOutputRunnable"],"sources":["../../../src/chains/openai_functions/base.d.ts"],"sourcesContent":["import type { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport type { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport type { Runnable, RunnableInterface } from \"@langchain/core/runnables\";\nimport type { BaseFunctionCallOptions, BaseLanguageModelInput, FunctionDefinition } from \"@langchain/core/language_models/base\";\nimport { type InputValues, InteropZodObject } from \"@langchain/core/utils/types\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\nimport { type JsonSchema7Type } from \"@langchain/core/utils/json_schema\";\n/**\n * Configuration params for the createOpenAIFnRunnable method.\n */\nexport type CreateOpenAIFnRunnableConfig<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any>, RunOutput> = {\n    functions: FunctionDefinition[];\n    /** Language model to use, assumed to support the OpenAI function-calling API. */\n    llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;\n    /** BasePromptTemplate to pass to the model. */\n    prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n    /**\n     * Only used if a single function is passed in. If `true`, then the model will be\n     * forced to use the given function. If `false`, then the model will be given the\n     * option to use the given function or not.\n     */\n    enforceSingleFunctionUsage?: boolean;\n    /**\n     * BaseLLMOutputParser to use for parsing model outputs.\n     * By default will be inferred from the function types.\n     */\n    outputParser?: BaseOutputParser<RunOutput>;\n};\n/**\n * Creates a runnable sequence that calls OpenAI functions.\n * @param config - The parameters required to create the runnable.\n * @returns A runnable sequence that will pass the given functions to the model when run.\n *\n * @example\n * ```typescript\n * const openAIFunction = {\n *   name: \"get_person_details\",\n *   description: \"Get details about a person\",\n *   parameters: {\n *     title: \"Person\",\n *     description: \"Identifying information about a person.\",\n *     type: \"object\",\n *     properties: {\n *       name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *       age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *       fav_food: {\n *         title: \"Fav Food\",\n *         description: \"The person's favorite food\",\n *         type: \"string\",\n *       },\n *     },\n *     required: [\"name\", \"age\"],\n *   },\n * };\n *\n * const model = new ChatOpenAI();\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * const runnable = createOpenAIFnRunnable({\n *   functions: [openAIFunction],\n *   llm: model,\n *   prompt,\n *   enforceSingleFunctionUsage: true, // Default is true\n *   outputParser\n * });\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport declare function createOpenAIFnRunnable<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any> = Record<string, any>, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunOutput extends Record<string, any> = Record<string, any>>(config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;\n/**\n * Configuration params for the createStructuredOutputRunnable method.\n */\nexport type CreateStructuredOutputRunnableConfig<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any>, RunOutput> = {\n    /**\n     * Schema to output. Must be either valid JSONSchema or a Zod schema.\n     */\n    outputSchema: InteropZodObject | JsonSchema7Type;\n    /**\n     * Language model to use, assumed to support the OpenAI function-calling API.\n     */\n    llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;\n    /** BasePromptTemplate to pass to the model. */\n    prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n    /**\n     * BaseLLMOutputParser to use for parsing model outputs.\n     */\n    outputParser?: BaseOutputParser<RunOutput>;\n};\n/**\n * @deprecated Prefer the `.withStructuredOutput` method on chat model classes.\n *\n * Create a runnable that uses an OpenAI function to get a structured output.\n * @param config Params required to create the runnable.\n * @returns A runnable sequence that will pass the given function to the model when run.\n *\n * @example\n * ```typescript\n * import { createStructuredOutputRunnable } from \"@langchain/classic/chains/openai_functions\";\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { ChatPromptTemplate } from \"@langchain/core/prompts\";\n * import { JsonOutputFunctionsParser } from \"@langchain/classic/output_parsers\";\n *\n * const jsonSchema = {\n *   title: \"Person\",\n *   description: \"Identifying information about a person.\",\n *   type: \"object\",\n *   properties: {\n *     name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *     age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *     fav_food: {\n *       title: \"Fav Food\",\n *       description: \"The person's favorite food\",\n *       type: \"string\",\n *     },\n *   },\n *   required: [\"name\", \"age\"],\n * };\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n *\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * // Also works with Zod schema\n * const runnable = createStructuredOutputRunnable({\n *   outputSchema: jsonSchema,\n *   llm: model,\n *   prompt,\n *   outputParser\n * });\n *\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport declare function createStructuredOutputRunnable<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any> = Record<string, any>, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunOutput extends Record<string, any> = Record<string, any>>(config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;\n"],"mappings":";;;;;;;;;;;;AAUA;AAAwC,KAA5BW,4BAA4B;;iBAEvBC,MACFN,CAAAA,MAAAA,EAAAA,GAAAA,CAAAA,EAAAA,SAAAA,CAAAA,GAAAA;EAAkB,SAEND,EAFZC,kBAEYD,EAAAA;EAAsB;EAAa,GAAED,EAAvDD,iBAAuDC,CAArCC,sBAAqCD,EAAbK,WAAaL,EAAAA,uBAAAA,CAAAA;EAAuB;EAA7D,MAE+BS,EAA7CZ,kBAA6CY,CAA1BN,WAA0BM,CAAdC,OAAcD,CAAAA,MAAAA,QAAAA,EAAAA,MAAAA,CAAAA,CAAAA,CAAAA;EAAQ;;;;;EAW9B,0BAAA,CAAA,EAAA,OAAA;EAoDXG;;;;EAEqB,YAE3BJ,CAAAA,EAxDCZ,gBAwDDY,CAxDkBG,SAwDlBH,CAAAA;CAAM;;;;;;;AAAyG;AAIjI;;;;;;;;;;;;;;;AAgBmC;AAyDnC;;;;;;;;;;;;AAIyI;;;;;;;;;;;;;;;iBArFjHI;;iBAEPJ,sBAAsBA;;kBAErBA,sBAAsBA,6BAA6BD,6BAA6BE,UAAUE,aAAab,SAASW,UAAUE;;;;KAIhIE;;iBAEKL;;;;gBAICJ,mBAAmBE;;;;OAI5BP,kBAAkBE,wBAAwBI,aAAaL;;UAEpDH,mBAAmBM,YAAYO,cAAcD;;;;iBAItCb,iBAAiBe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyDZG;;iBAEPN,sBAAsBA;;kBAErBA,sBAAsBA,6BAA6BK,qCAAqCJ,UAAUE,aAAab,SAASW,UAAUE"}

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

@@ -0,0 +1,172 @@
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { Runnable, RunnableInterface } from "@langchain/core/runnables";
+import { BaseFunctionCallOptions, BaseLanguageModelInput, FunctionDefinition } from "@langchain/core/language_models/base";
+import { BaseOutputParser } from "@langchain/core/output_parsers";
+import { BaseMessage } from "@langchain/core/messages";
+import { InputValues, InteropZodObject } from "@langchain/core/utils/types";
+import { JsonSchema7Type } from "@langchain/core/utils/json_schema";
+
+//#region src/chains/openai_functions/base.d.ts
+
+/**
+ * Configuration params for the createOpenAIFnRunnable method.
+ */
+type CreateOpenAIFnRunnableConfig<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any>, RunOutput> = {
+  functions: FunctionDefinition[];
+  /** Language model to use, assumed to support the OpenAI function-calling API. */
+  llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;
+  /** BasePromptTemplate to pass to the model. */
+  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;
+  /**
+   * Only used if a single function is passed in. If `true`, then the model will be
+   * forced to use the given function. If `false`, then the model will be given the
+   * option to use the given function or not.
+   */
+  enforceSingleFunctionUsage?: boolean;
+  /**
+   * BaseLLMOutputParser to use for parsing model outputs.
+   * By default will be inferred from the function types.
+   */
+  outputParser?: BaseOutputParser<RunOutput>;
+};
+/**
+ * Creates a runnable sequence that calls OpenAI functions.
+ * @param config - The parameters required to create the runnable.
+ * @returns A runnable sequence that will pass the given functions to the model when run.
+ *
+ * @example
+ * ```typescript
+ * const openAIFunction = {
+ *   name: "get_person_details",
+ *   description: "Get details about a person",
+ *   parameters: {
+ *     title: "Person",
+ *     description: "Identifying information about a person.",
+ *     type: "object",
+ *     properties: {
+ *       name: { title: "Name", description: "The person's name", type: "string" },
+ *       age: { title: "Age", description: "The person's age", type: "integer" },
+ *       fav_food: {
+ *         title: "Fav Food",
+ *         description: "The person's favorite food",
+ *         type: "string",
+ *       },
+ *     },
+ *     required: ["name", "age"],
+ *   },
+ * };
+ *
+ * const model = new ChatOpenAI();
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["human", "Human description: {description}"],
+ * ]);
+ * const outputParser = new JsonOutputFunctionsParser();
+ *
+ * const runnable = createOpenAIFnRunnable({
+ *   functions: [openAIFunction],
+ *   llm: model,
+ *   prompt,
+ *   enforceSingleFunctionUsage: true, // Default is true
+ *   outputParser
+ * });
+ * const response = await runnable.invoke({
+ *   description:
+ *     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+ * });
+ *
+ * console.log(response);
+ *
+ * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+ * ```
+ */
+declare function createOpenAIFnRunnable<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any> = Record<string, any>,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunOutput extends Record<string, any> = Record<string, any>>(config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;
+/**
+ * Configuration params for the createStructuredOutputRunnable method.
+ */
+type CreateStructuredOutputRunnableConfig<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any>, RunOutput> = {
+  /**
+   * Schema to output. Must be either valid JSONSchema or a Zod schema.
+   */
+  outputSchema: InteropZodObject | JsonSchema7Type;
+  /**
+   * Language model to use, assumed to support the OpenAI function-calling API.
+   */
+  llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;
+  /** BasePromptTemplate to pass to the model. */
+  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;
+  /**
+   * BaseLLMOutputParser to use for parsing model outputs.
+   */
+  outputParser?: BaseOutputParser<RunOutput>;
+};
+/**
+ * @deprecated Prefer the `.withStructuredOutput` method on chat model classes.
+ *
+ * Create a runnable that uses an OpenAI function to get a structured output.
+ * @param config Params required to create the runnable.
+ * @returns A runnable sequence that will pass the given function to the model when run.
+ *
+ * @example
+ * ```typescript
+ * import { createStructuredOutputRunnable } from "@langchain/classic/chains/openai_functions";
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { ChatPromptTemplate } from "@langchain/core/prompts";
+ * import { JsonOutputFunctionsParser } from "@langchain/classic/output_parsers";
+ *
+ * const jsonSchema = {
+ *   title: "Person",
+ *   description: "Identifying information about a person.",
+ *   type: "object",
+ *   properties: {
+ *     name: { title: "Name", description: "The person's name", type: "string" },
+ *     age: { title: "Age", description: "The person's age", type: "integer" },
+ *     fav_food: {
+ *       title: "Fav Food",
+ *       description: "The person's favorite food",
+ *       type: "string",
+ *     },
+ *   },
+ *   required: ["name", "age"],
+ * };
+ *
+ * const model = new ChatOpenAI({ model: "gpt-4o-mini" });
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["human", "Human description: {description}"],
+ * ]);
+ *
+ * const outputParser = new JsonOutputFunctionsParser();
+ *
+ * // Also works with Zod schema
+ * const runnable = createStructuredOutputRunnable({
+ *   outputSchema: jsonSchema,
+ *   llm: model,
+ *   prompt,
+ *   outputParser
+ * });
+ *
+ * const response = await runnable.invoke({
+ *   description:
+ *     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+ * });
+ *
+ * console.log(response);
+ *
+ * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+ * ```
+ */
+declare function createStructuredOutputRunnable<
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunInput extends Record<string, any> = Record<string, any>,
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+RunOutput extends Record<string, any> = Record<string, any>>(config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;
+//#endregion
+export { CreateOpenAIFnRunnableConfig, CreateStructuredOutputRunnableConfig, createOpenAIFnRunnable, createStructuredOutputRunnable };
+//# sourceMappingURL=base.d.ts.map

package/dist/chains/openai_functions/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","names":["BaseOutputParser","BasePromptTemplate","Runnable","RunnableInterface","BaseFunctionCallOptions","BaseLanguageModelInput","FunctionDefinition","InputValues","InteropZodObject","BaseMessage","JsonSchema7Type","CreateOpenAIFnRunnableConfig","Record","RunInput","Extract","RunOutput","createOpenAIFnRunnable","CreateStructuredOutputRunnableConfig","createStructuredOutputRunnable"],"sources":["../../../src/chains/openai_functions/base.d.ts"],"sourcesContent":["import type { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport type { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport type { Runnable, RunnableInterface } from \"@langchain/core/runnables\";\nimport type { BaseFunctionCallOptions, BaseLanguageModelInput, FunctionDefinition } from \"@langchain/core/language_models/base\";\nimport { type InputValues, InteropZodObject } from \"@langchain/core/utils/types\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\nimport { type JsonSchema7Type } from \"@langchain/core/utils/json_schema\";\n/**\n * Configuration params for the createOpenAIFnRunnable method.\n */\nexport type CreateOpenAIFnRunnableConfig<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any>, RunOutput> = {\n    functions: FunctionDefinition[];\n    /** Language model to use, assumed to support the OpenAI function-calling API. */\n    llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;\n    /** BasePromptTemplate to pass to the model. */\n    prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n    /**\n     * Only used if a single function is passed in. If `true`, then the model will be\n     * forced to use the given function. If `false`, then the model will be given the\n     * option to use the given function or not.\n     */\n    enforceSingleFunctionUsage?: boolean;\n    /**\n     * BaseLLMOutputParser to use for parsing model outputs.\n     * By default will be inferred from the function types.\n     */\n    outputParser?: BaseOutputParser<RunOutput>;\n};\n/**\n * Creates a runnable sequence that calls OpenAI functions.\n * @param config - The parameters required to create the runnable.\n * @returns A runnable sequence that will pass the given functions to the model when run.\n *\n * @example\n * ```typescript\n * const openAIFunction = {\n *   name: \"get_person_details\",\n *   description: \"Get details about a person\",\n *   parameters: {\n *     title: \"Person\",\n *     description: \"Identifying information about a person.\",\n *     type: \"object\",\n *     properties: {\n *       name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *       age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *       fav_food: {\n *         title: \"Fav Food\",\n *         description: \"The person's favorite food\",\n *         type: \"string\",\n *       },\n *     },\n *     required: [\"name\", \"age\"],\n *   },\n * };\n *\n * const model = new ChatOpenAI();\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * const runnable = createOpenAIFnRunnable({\n *   functions: [openAIFunction],\n *   llm: model,\n *   prompt,\n *   enforceSingleFunctionUsage: true, // Default is true\n *   outputParser\n * });\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport declare function createOpenAIFnRunnable<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any> = Record<string, any>, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunOutput extends Record<string, any> = Record<string, any>>(config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;\n/**\n * Configuration params for the createStructuredOutputRunnable method.\n */\nexport type CreateStructuredOutputRunnableConfig<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any>, RunOutput> = {\n    /**\n     * Schema to output. Must be either valid JSONSchema or a Zod schema.\n     */\n    outputSchema: InteropZodObject | JsonSchema7Type;\n    /**\n     * Language model to use, assumed to support the OpenAI function-calling API.\n     */\n    llm: RunnableInterface<BaseLanguageModelInput, BaseMessage, BaseFunctionCallOptions>;\n    /** BasePromptTemplate to pass to the model. */\n    prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n    /**\n     * BaseLLMOutputParser to use for parsing model outputs.\n     */\n    outputParser?: BaseOutputParser<RunOutput>;\n};\n/**\n * @deprecated Prefer the `.withStructuredOutput` method on chat model classes.\n *\n * Create a runnable that uses an OpenAI function to get a structured output.\n * @param config Params required to create the runnable.\n * @returns A runnable sequence that will pass the given function to the model when run.\n *\n * @example\n * ```typescript\n * import { createStructuredOutputRunnable } from \"@langchain/classic/chains/openai_functions\";\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { ChatPromptTemplate } from \"@langchain/core/prompts\";\n * import { JsonOutputFunctionsParser } from \"@langchain/classic/output_parsers\";\n *\n * const jsonSchema = {\n *   title: \"Person\",\n *   description: \"Identifying information about a person.\",\n *   type: \"object\",\n *   properties: {\n *     name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *     age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *     fav_food: {\n *       title: \"Fav Food\",\n *       description: \"The person's favorite food\",\n *       type: \"string\",\n *     },\n *   },\n *   required: [\"name\", \"age\"],\n * };\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n *\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * // Also works with Zod schema\n * const runnable = createStructuredOutputRunnable({\n *   outputSchema: jsonSchema,\n *   llm: model,\n *   prompt,\n *   outputParser\n * });\n *\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport declare function createStructuredOutputRunnable<\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunInput extends Record<string, any> = Record<string, any>, \n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nRunOutput extends Record<string, any> = Record<string, any>>(config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>): Runnable<RunInput, RunOutput>;\n"],"mappings":";;;;;;;;;;;;AAUA;AAAwC,KAA5BW,4BAA4B;;iBAEvBC,MACFN,CAAAA,MAAAA,EAAAA,GAAAA,CAAAA,EAAAA,SAAAA,CAAAA,GAAAA;EAAkB,SAEND,EAFZC,kBAEYD,EAAAA;EAAsB;EAAa,GAAED,EAAvDD,iBAAuDC,CAArCC,sBAAqCD,EAAbK,WAAaL,EAAAA,uBAAAA,CAAAA;EAAuB;EAA7D,MAE+BS,EAA7CZ,kBAA6CY,CAA1BN,WAA0BM,CAAdC,OAAcD,CAAAA,MAAAA,QAAAA,EAAAA,MAAAA,CAAAA,CAAAA,CAAAA;EAAQ;;;;;EAW9B,0BAAA,CAAA,EAAA,OAAA;EAoDXG;;;;EAEqB,YAE3BJ,CAAAA,EAxDCZ,gBAwDDY,CAxDkBG,SAwDlBH,CAAAA;CAAM;;;;;;;AAAyG;AAIjI;;;;;;;;;;;;;;;AAgBmC;AAyDnC;;;;;;;;;;;;AAIyI;;;;;;;;;;;;;;;iBArFjHI;;iBAEPJ,sBAAsBA;;kBAErBA,sBAAsBA,6BAA6BD,6BAA6BE,UAAUE,aAAab,SAASW,UAAUE;;;;KAIhIE;;iBAEKL;;;;gBAICJ,mBAAmBE;;;;OAI5BP,kBAAkBE,wBAAwBI,aAAaL;;UAEpDH,mBAAmBM,YAAYO,cAAcD;;;;iBAItCb,iBAAiBe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyDZG;;iBAEPN,sBAAsBA;;kBAErBA,sBAAsBA,6BAA6BK,qCAAqCJ,UAAUE,aAAab,SAASW,UAAUE"}

package/dist/chains/openai_functions/base.js

@@ -0,0 +1,137 @@
+import { JsonOutputFunctionsParser } from "../../output_parsers/openai_functions.js";
+import { isInteropZodSchema } from "@langchain/core/utils/types";
+import { toJsonSchema } from "@langchain/core/utils/json_schema";
+
+//#region src/chains/openai_functions/base.ts
+/**
+* Creates a runnable sequence that calls OpenAI functions.
+* @param config - The parameters required to create the runnable.
+* @returns A runnable sequence that will pass the given functions to the model when run.
+*
+* @example
+* ```typescript
+* const openAIFunction = {
+*   name: "get_person_details",
+*   description: "Get details about a person",
+*   parameters: {
+*     title: "Person",
+*     description: "Identifying information about a person.",
+*     type: "object",
+*     properties: {
+*       name: { title: "Name", description: "The person's name", type: "string" },
+*       age: { title: "Age", description: "The person's age", type: "integer" },
+*       fav_food: {
+*         title: "Fav Food",
+*         description: "The person's favorite food",
+*         type: "string",
+*       },
+*     },
+*     required: ["name", "age"],
+*   },
+* };
+*
+* const model = new ChatOpenAI();
+* const prompt = ChatPromptTemplate.fromMessages([
+*   ["human", "Human description: {description}"],
+* ]);
+* const outputParser = new JsonOutputFunctionsParser();
+*
+* const runnable = createOpenAIFnRunnable({
+*   functions: [openAIFunction],
+*   llm: model,
+*   prompt,
+*   enforceSingleFunctionUsage: true, // Default is true
+*   outputParser
+* });
+* const response = await runnable.invoke({
+*   description:
+*     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+* });
+*
+* console.log(response);
+*
+* // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+* ```
+*/
+function createOpenAIFnRunnable(config) {
+	const { functions, llm, prompt, enforceSingleFunctionUsage = true, outputParser = new JsonOutputFunctionsParser() } = config;
+	const llmKwargs = { functions };
+	if (functions.length === 1 && enforceSingleFunctionUsage) llmKwargs.function_call = { name: functions[0].name };
+	const llmWithKwargs = llm.withConfig(llmKwargs);
+	return prompt.pipe(llmWithKwargs).pipe(outputParser);
+}
+/**
+* @deprecated Prefer the `.withStructuredOutput` method on chat model classes.
+*
+* Create a runnable that uses an OpenAI function to get a structured output.
+* @param config Params required to create the runnable.
+* @returns A runnable sequence that will pass the given function to the model when run.
+*
+* @example
+* ```typescript
+* import { createStructuredOutputRunnable } from "@langchain/classic/chains/openai_functions";
+* import { ChatOpenAI } from "@langchain/openai";
+* import { ChatPromptTemplate } from "@langchain/core/prompts";
+* import { JsonOutputFunctionsParser } from "@langchain/classic/output_parsers";
+*
+* const jsonSchema = {
+*   title: "Person",
+*   description: "Identifying information about a person.",
+*   type: "object",
+*   properties: {
+*     name: { title: "Name", description: "The person's name", type: "string" },
+*     age: { title: "Age", description: "The person's age", type: "integer" },
+*     fav_food: {
+*       title: "Fav Food",
+*       description: "The person's favorite food",
+*       type: "string",
+*     },
+*   },
+*   required: ["name", "age"],
+* };
+*
+* const model = new ChatOpenAI({ model: "gpt-4o-mini" });
+* const prompt = ChatPromptTemplate.fromMessages([
+*   ["human", "Human description: {description}"],
+* ]);
+*
+* const outputParser = new JsonOutputFunctionsParser();
+*
+* // Also works with Zod schema
+* const runnable = createStructuredOutputRunnable({
+*   outputSchema: jsonSchema,
+*   llm: model,
+*   prompt,
+*   outputParser
+* });
+*
+* const response = await runnable.invoke({
+*   description:
+*     "My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.",
+* });
+*
+* console.log(response);
+*
+* // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }
+* ```
+*/
+function createStructuredOutputRunnable(config) {
+	const { outputSchema, llm, prompt, outputParser } = config;
+	const jsonSchema = isInteropZodSchema(outputSchema) ? toJsonSchema(outputSchema) : outputSchema;
+	const oaiFunction = {
+		name: "outputFormatter",
+		description: "Output formatter. Should always be used to format your response to the user",
+		parameters: jsonSchema
+	};
+	return createOpenAIFnRunnable({
+		functions: [oaiFunction],
+		llm,
+		prompt,
+		enforceSingleFunctionUsage: true,
+		outputParser
+	});
+}
+
+//#endregion
+export { createOpenAIFnRunnable, createStructuredOutputRunnable };
+//# sourceMappingURL=base.js.map

package/dist/chains/openai_functions/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","names":["config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>","llmKwargs: BaseFunctionCallOptions","config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>","oaiFunction: FunctionDefinition"],"sources":["../../../src/chains/openai_functions/base.ts"],"sourcesContent":["import type { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport type { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport type { Runnable, RunnableInterface } from \"@langchain/core/runnables\";\nimport type {\n  BaseFunctionCallOptions,\n  BaseLanguageModelInput,\n  FunctionDefinition,\n} from \"@langchain/core/language_models/base\";\nimport {\n  isInteropZodSchema,\n  type InputValues,\n  InteropZodObject,\n} from \"@langchain/core/utils/types\";\nimport type { BaseMessage } from \"@langchain/core/messages\";\nimport {\n  toJsonSchema,\n  type JsonSchema7Type,\n} from \"@langchain/core/utils/json_schema\";\nimport { JsonOutputFunctionsParser } from \"../../output_parsers/openai_functions.js\";\n\n/**\n * Configuration params for the createOpenAIFnRunnable method.\n */\nexport type CreateOpenAIFnRunnableConfig<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunInput extends Record<string, any>,\n  RunOutput\n> = {\n  functions: FunctionDefinition[];\n  /** Language model to use, assumed to support the OpenAI function-calling API. */\n  llm: RunnableInterface<\n    BaseLanguageModelInput,\n    BaseMessage,\n    BaseFunctionCallOptions\n  >;\n  /** BasePromptTemplate to pass to the model. */\n  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n  /**\n   * Only used if a single function is passed in. If `true`, then the model will be\n   * forced to use the given function. If `false`, then the model will be given the\n   * option to use the given function or not.\n   */\n  enforceSingleFunctionUsage?: boolean;\n  /**\n   * BaseLLMOutputParser to use for parsing model outputs.\n   * By default will be inferred from the function types.\n   */\n  outputParser?: BaseOutputParser<RunOutput>;\n};\n\n/**\n * Creates a runnable sequence that calls OpenAI functions.\n * @param config - The parameters required to create the runnable.\n * @returns A runnable sequence that will pass the given functions to the model when run.\n *\n * @example\n * ```typescript\n * const openAIFunction = {\n *   name: \"get_person_details\",\n *   description: \"Get details about a person\",\n *   parameters: {\n *     title: \"Person\",\n *     description: \"Identifying information about a person.\",\n *     type: \"object\",\n *     properties: {\n *       name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *       age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *       fav_food: {\n *         title: \"Fav Food\",\n *         description: \"The person's favorite food\",\n *         type: \"string\",\n *       },\n *     },\n *     required: [\"name\", \"age\"],\n *   },\n * };\n *\n * const model = new ChatOpenAI();\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * const runnable = createOpenAIFnRunnable({\n *   functions: [openAIFunction],\n *   llm: model,\n *   prompt,\n *   enforceSingleFunctionUsage: true, // Default is true\n *   outputParser\n * });\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport function createOpenAIFnRunnable<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunInput extends Record<string, any> = Record<string, any>,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunOutput extends Record<string, any> = Record<string, any>\n>(\n  config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>\n): Runnable<RunInput, RunOutput> {\n  const {\n    functions,\n    llm,\n    prompt,\n    enforceSingleFunctionUsage = true,\n    outputParser = new JsonOutputFunctionsParser<RunOutput>(),\n  } = config;\n  const llmKwargs: BaseFunctionCallOptions = {\n    functions,\n  };\n\n  if (functions.length === 1 && enforceSingleFunctionUsage) {\n    llmKwargs.function_call = {\n      name: functions[0].name,\n    };\n  }\n\n  const llmWithKwargs = (llm as Runnable).withConfig(llmKwargs);\n  return prompt.pipe(llmWithKwargs).pipe(outputParser);\n}\n\n/**\n * Configuration params for the createStructuredOutputRunnable method.\n */\nexport type CreateStructuredOutputRunnableConfig<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunInput extends Record<string, any>,\n  RunOutput\n> = {\n  /**\n   * Schema to output. Must be either valid JSONSchema or a Zod schema.\n   */\n  outputSchema: InteropZodObject | JsonSchema7Type;\n  /**\n   * Language model to use, assumed to support the OpenAI function-calling API.\n   */\n  llm: RunnableInterface<\n    BaseLanguageModelInput,\n    BaseMessage,\n    BaseFunctionCallOptions\n  >;\n  /** BasePromptTemplate to pass to the model. */\n  prompt: BasePromptTemplate<InputValues<Extract<keyof RunInput, string>>>;\n  /**\n   * BaseLLMOutputParser to use for parsing model outputs.\n   */\n  outputParser?: BaseOutputParser<RunOutput>;\n};\n\n/**\n * @deprecated Prefer the `.withStructuredOutput` method on chat model classes.\n *\n * Create a runnable that uses an OpenAI function to get a structured output.\n * @param config Params required to create the runnable.\n * @returns A runnable sequence that will pass the given function to the model when run.\n *\n * @example\n * ```typescript\n * import { createStructuredOutputRunnable } from \"@langchain/classic/chains/openai_functions\";\n * import { ChatOpenAI } from \"@langchain/openai\";\n * import { ChatPromptTemplate } from \"@langchain/core/prompts\";\n * import { JsonOutputFunctionsParser } from \"@langchain/classic/output_parsers\";\n *\n * const jsonSchema = {\n *   title: \"Person\",\n *   description: \"Identifying information about a person.\",\n *   type: \"object\",\n *   properties: {\n *     name: { title: \"Name\", description: \"The person's name\", type: \"string\" },\n *     age: { title: \"Age\", description: \"The person's age\", type: \"integer\" },\n *     fav_food: {\n *       title: \"Fav Food\",\n *       description: \"The person's favorite food\",\n *       type: \"string\",\n *     },\n *   },\n *   required: [\"name\", \"age\"],\n * };\n *\n * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n * const prompt = ChatPromptTemplate.fromMessages([\n *   [\"human\", \"Human description: {description}\"],\n * ]);\n *\n * const outputParser = new JsonOutputFunctionsParser();\n *\n * // Also works with Zod schema\n * const runnable = createStructuredOutputRunnable({\n *   outputSchema: jsonSchema,\n *   llm: model,\n *   prompt,\n *   outputParser\n * });\n *\n * const response = await runnable.invoke({\n *   description:\n *     \"My name's John Doe and I'm 30 years old. My favorite kind of food are chocolate chip cookies.\",\n * });\n *\n * console.log(response);\n *\n * // { name: 'John Doe', age: 30, fav_food: 'chocolate chip cookies' }\n * ```\n */\nexport function createStructuredOutputRunnable<\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunInput extends Record<string, any> = Record<string, any>,\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  RunOutput extends Record<string, any> = Record<string, any>\n>(\n  config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>\n): Runnable<RunInput, RunOutput> {\n  const { outputSchema, llm, prompt, outputParser } = config;\n  const jsonSchema = isInteropZodSchema(outputSchema)\n    ? toJsonSchema(outputSchema)\n    : outputSchema;\n  const oaiFunction: FunctionDefinition = {\n    name: \"outputFormatter\",\n    description:\n      \"Output formatter. Should always be used to format your response to the user\",\n    parameters: jsonSchema,\n  };\n\n  return createOpenAIFnRunnable({\n    functions: [oaiFunction],\n    llm,\n    prompt,\n    enforceSingleFunctionUsage: true,\n    outputParser,\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoGA,SAAgB,uBAMdA,QAC+B;CAC/B,MAAM,EACJ,WACA,KACA,QACA,6BAA6B,MAC7B,eAAe,IAAI,6BACpB,GAAG;CACJ,MAAMC,YAAqC,EACzC,UACD;AAED,KAAI,UAAU,WAAW,KAAK,4BAC5B,UAAU,gBAAgB,EACxB,MAAM,UAAU,GAAG,KACpB;CAGH,MAAM,gBAAiB,IAAiB,WAAW,UAAU;AAC7D,QAAO,OAAO,KAAK,cAAc,CAAC,KAAK,aAAa;AACrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqFD,SAAgB,+BAMdC,QAC+B;CAC/B,MAAM,EAAE,cAAc,KAAK,QAAQ,cAAc,GAAG;CACpD,MAAM,aAAa,mBAAmB,aAAa,GAC/C,aAAa,aAAa,GAC1B;CACJ,MAAMC,cAAkC;EACtC,MAAM;EACN,aACE;EACF,YAAY;CACb;AAED,QAAO,uBAAuB;EAC5B,WAAW,CAAC,WAAY;EACxB;EACA;EACA,4BAA4B;EAC5B;CACD,EAAC;AACH"}

package/dist/chains/openai_functions/extraction.cjs

@@ -0,0 +1,71 @@
+const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
+const require_llm_chain = require('../llm_chain.cjs');
+const require_openai_functions = require('../../output_parsers/openai_functions.cjs');
+const __langchain_core_prompts = require_rolldown_runtime.__toESM(require("@langchain/core/prompts"));
+const __langchain_core_utils_json_schema = require_rolldown_runtime.__toESM(require("@langchain/core/utils/json_schema"));
+
+//#region src/chains/openai_functions/extraction.ts
+/**
+* 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 [{
+		name: "information_extraction",
+		description: "Extracts the relevant information from the passage.",
+		parameters: {
+			type: "object",
+			properties: { info: {
+				type: "array",
+				items: {
+					type: schema.type,
+					properties: schema.properties,
+					required: schema.required
+				}
+			} },
+			required: ["info"]
+		}
+	}];
+}
+const _EXTRACTION_TEMPLATE = `Extract and save the relevant entities mentioned in the following passage together with their properties.
+
+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 or AnthropicFunctions 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 = __langchain_core_prompts.PromptTemplate.fromTemplate(_EXTRACTION_TEMPLATE);
+	const outputParser = new require_openai_functions.JsonKeyOutputFunctionsParser({ attrName: "info" });
+	return new require_llm_chain.LLMChain({
+		llm,
+		prompt,
+		llmKwargs: { functions },
+		outputParser,
+		tags: ["openai_functions", "extraction"]
+	});
+}
+/**
+* Function that creates an extraction chain from a Zod schema. It
+* converts the Zod schema to a JSON schema using before creating
+* the extraction chain.
+* @param schema The Zod schema which extracted data should match
+* @param llm Must be a ChatOpenAI or AnthropicFunctions model that supports function calling.
+* @returns A LLMChain instance configured to return data matching the schema.
+*/
+function createExtractionChainFromZod(schema, llm) {
+	return createExtractionChain((0, __langchain_core_utils_json_schema.toJsonSchema)(schema), llm);
+}
+
+//#endregion
+exports.createExtractionChain = createExtractionChain;
+exports.createExtractionChainFromZod = createExtractionChainFromZod;
+//# sourceMappingURL=extraction.cjs.map

package/dist/chains/openai_functions/extraction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.cjs","names":["schema: FunctionParameters","llm: BaseChatModel<BaseFunctionCallOptions>","PromptTemplate","JsonKeyOutputFunctionsParser","LLMChain","schema: InteropZodObject"],"sources":["../../../src/chains/openai_functions/extraction.ts"],"sourcesContent":["import { BaseChatModel } from \"@langchain/core/language_models/chat_models\";\nimport { BaseFunctionCallOptions } from \"@langchain/core/language_models/base\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { InteropZodObject } from \"@langchain/core/utils/types\";\nimport type { AIMessageChunk } from \"@langchain/core/messages\";\nimport {\n  type JsonSchema7ObjectType,\n  toJsonSchema,\n} from \"@langchain/core/utils/json_schema\";\nimport {\n  FunctionParameters,\n  JsonKeyOutputFunctionsParser,\n} from \"../../output_parsers/openai_functions.js\";\nimport { LLMChain } from \"../llm_chain.js\";\n\n/**\n * Function that returns an array of extraction functions. These functions\n * are used to extract relevant information from a passage.\n * @param schema The schema of the function parameters.\n * @returns An array of extraction functions.\n */\nfunction getExtractionFunctions(schema: FunctionParameters) {\n  return [\n    {\n      name: \"information_extraction\",\n      description: \"Extracts the relevant information from the passage.\",\n      parameters: {\n        type: \"object\",\n        properties: {\n          info: {\n            type: \"array\",\n            items: {\n              type: schema.type,\n              properties: schema.properties,\n              required: schema.required,\n            },\n          },\n        },\n        required: [\"info\"],\n      },\n    },\n  ];\n}\n\nconst _EXTRACTION_TEMPLATE = `Extract and save the relevant entities mentioned in the following passage together with their properties.\n\nPassage:\n{input}\n`;\n\n/**\n * Function that creates an extraction chain using the provided JSON schema.\n * It sets up the necessary components, such as the prompt, output parser, and tags.\n * @param schema JSON schema of the function parameters.\n * @param llm Must be a ChatOpenAI or AnthropicFunctions model that supports function calling.\n * @returns A LLMChain instance configured to return data matching the schema.\n */\nexport function createExtractionChain(\n  schema: FunctionParameters,\n  llm: BaseChatModel<BaseFunctionCallOptions>\n): LLMChain<object, BaseChatModel<BaseFunctionCallOptions, AIMessageChunk>> {\n  const functions = getExtractionFunctions(schema);\n  const prompt = PromptTemplate.fromTemplate(_EXTRACTION_TEMPLATE);\n  const outputParser = new JsonKeyOutputFunctionsParser({ attrName: \"info\" });\n  return new LLMChain({\n    llm,\n    prompt,\n    llmKwargs: { functions },\n    outputParser,\n    tags: [\"openai_functions\", \"extraction\"],\n  });\n}\n\n/**\n * Function that creates an extraction chain from a Zod schema. It\n * converts the Zod schema to a JSON schema using before creating\n * the extraction chain.\n * @param schema The Zod schema which extracted data should match\n * @param llm Must be a ChatOpenAI or AnthropicFunctions model that supports function calling.\n * @returns A LLMChain instance configured to return data matching the schema.\n */\nexport function createExtractionChainFromZod(\n  schema: InteropZodObject,\n  llm: BaseChatModel<BaseFunctionCallOptions>\n): LLMChain<object, BaseChatModel<BaseFunctionCallOptions, AIMessageChunk>> {\n  return createExtractionChain(\n    toJsonSchema(schema) as JsonSchema7ObjectType,\n    llm\n  );\n}\n"],"mappings":";;;;;;;;;;;;;AAqBA,SAAS,uBAAuBA,QAA4B;AAC1D,QAAO,CACL;EACE,MAAM;EACN,aAAa;EACb,YAAY;GACV,MAAM;GACN,YAAY,EACV,MAAM;IACJ,MAAM;IACN,OAAO;KACL,MAAM,OAAO;KACb,YAAY,OAAO;KACnB,UAAU,OAAO;IAClB;GACF,EACF;GACD,UAAU,CAAC,MAAO;EACnB;CACF,CACF;AACF;AAED,MAAM,uBAAuB,CAAC;;;;AAI9B,CAAC;;;;;;;;AASD,SAAgB,sBACdA,QACAC,KAC0E;CAC1E,MAAM,YAAY,uBAAuB,OAAO;CAChD,MAAM,SAASC,wCAAe,aAAa,qBAAqB;CAChE,MAAM,eAAe,IAAIC,sDAA6B,EAAE,UAAU,OAAQ;AAC1E,QAAO,IAAIC,2BAAS;EAClB;EACA;EACA,WAAW,EAAE,UAAW;EACxB;EACA,MAAM,CAAC,oBAAoB,YAAa;CACzC;AACF;;;;;;;;;AAUD,SAAgB,6BACdC,QACAJ,KAC0E;AAC1E,QAAO,2EACQ,OAAO,EACpB,IACD;AACF"}