langchain 0.1.0 → 0.1.1

package/dist/chains/openai_functions/base.cjs

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStructuredOutputRunnable = exports.createOpenAIFnRunnable = void 0;
+const zod_to_json_schema_1 = require("zod-to-json-schema");
+const openai_functions_js_1 = require("../../output_parsers/openai_functions.cjs");
+/**
+ * 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 openai_functions_js_1.JsonOutputFunctionsParser(), } = config;
+    const llmKwargs = {
+        functions,
+    };
+    if (functions.length === 1 && enforceSingleFunctionUsage) {
+        llmKwargs.function_call = {
+            name: functions[0].name,
+        };
+    }
+    const llmWithKwargs = llm.bind(llmKwargs);
+    return prompt.pipe(llmWithKwargs).pipe(outputParser);
+}
+exports.createOpenAIFnRunnable = createOpenAIFnRunnable;
+function isZodSchema(schema) {
+    return typeof schema.safeParse === "function";
+}
+/**
+ * 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/chains/openai_functions";
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { ChatPromptTemplate } from "@langchain/core/prompts";
+ * import { JsonOutputFunctionsParser } from "langchain/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();
+ * 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 = isZodSchema(outputSchema)
+        ? (0, zod_to_json_schema_1.zodToJsonSchema)(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,
+    });
+}
+exports.createStructuredOutputRunnable = createStructuredOutputRunnable;

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

@@ -0,0 +1,153 @@
+import type { z } from "zod";
+import { JsonSchema7Type } from "zod-to-json-schema/src/parseDef.js";
+import type { BaseOutputParser } from "@langchain/core/output_parsers";
+import type { BasePromptTemplate } from "@langchain/core/prompts";
+import type { RunnableInterface } from "@langchain/core/runnables";
+import type { BaseFunctionCallOptions, BaseLanguageModelInput, FunctionDefinition } from "@langchain/core/language_models/base";
+import type { InputValues } from "@langchain/core/utils/types";
+import type { BaseMessage } from "@langchain/core/messages";
+/**
+ * Configuration params for the createOpenAIFnRunnable method.
+ */
+export type CreateOpenAIFnRunnableConfig<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' }
+ * ```
+ */
+export declare function createOpenAIFnRunnable<RunInput extends Record<string, any> = Record<string, any>, RunOutput extends Record<string, any> = Record<string, any>>(config: CreateOpenAIFnRunnableConfig<RunInput, RunOutput>): RunnableInterface<RunInput, RunOutput>;
+/**
+ * Configuration params for the createStructuredOutputRunnable method.
+ */
+export type CreateStructuredOutputRunnableConfig<RunInput extends Record<string, any>, RunOutput> = {
+    /**
+     * Schema to output. Must be either valid JSONSchema or a Zod schema.
+     */
+    outputSchema: z.AnyZodObject | 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>;
+};
+/**
+ * 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/chains/openai_functions";
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { ChatPromptTemplate } from "@langchain/core/prompts";
+ * import { JsonOutputFunctionsParser } from "langchain/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();
+ * 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' }
+ * ```
+ */
+export declare function createStructuredOutputRunnable<RunInput extends Record<string, any> = Record<string, any>, RunOutput extends Record<string, any> = Record<string, any>>(config: CreateStructuredOutputRunnableConfig<RunInput, RunOutput>): RunnableInterface<RunInput, RunOutput>;

package/dist/chains/openai_functions/base.js

@@ -0,0 +1,139 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
+import { JsonOutputFunctionsParser } from "../../output_parsers/openai_functions.js";
+/**
+ * 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' }
+ * ```
+ */
+export 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.bind(llmKwargs);
+    return prompt.pipe(llmWithKwargs).pipe(outputParser);
+}
+function isZodSchema(schema) {
+    return typeof schema.safeParse === "function";
+}
+/**
+ * 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/chains/openai_functions";
+ * import { ChatOpenAI } from "@langchain/openai";
+ * import { ChatPromptTemplate } from "@langchain/core/prompts";
+ * import { JsonOutputFunctionsParser } from "langchain/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();
+ * 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' }
+ * ```
+ */
+export function createStructuredOutputRunnable(config) {
+    const { outputSchema, llm, prompt, outputParser } = config;
+    const jsonSchema = isZodSchema(outputSchema)
+        ? zodToJsonSchema(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,
+    });
+}

package/dist/chains/openai_functions/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStructuredOutputChainFromZod = exports.createStructuredOutputChain = exports.createOpenAPIChain = exports.createTaggingChainFromZod = exports.createTaggingChain = exports.createExtractionChainFromZod = exports.createExtractionChain = void 0;
+exports.createOpenAIFnRunnable = exports.createStructuredOutputRunnable = exports.createStructuredOutputChainFromZod = exports.createStructuredOutputChain = exports.createOpenAPIChain = exports.createTaggingChainFromZod = exports.createTaggingChain = exports.createExtractionChainFromZod = exports.createExtractionChain = void 0;
 var extraction_js_1 = require("./extraction.cjs");
 Object.defineProperty(exports, "createExtractionChain", { enumerable: true, get: function () { return extraction_js_1.createExtractionChain; } });
 Object.defineProperty(exports, "createExtractionChainFromZod", { enumerable: true, get: function () { return extraction_js_1.createExtractionChainFromZod; } });
@@ -12,3 +12,6 @@ Object.defineProperty(exports, "createOpenAPIChain", { enumerable: true, get: fu
 var structured_output_js_1 = require("./structured_output.cjs");
 Object.defineProperty(exports, "createStructuredOutputChain", { enumerable: true, get: function () { return structured_output_js_1.createStructuredOutputChain; } });
 Object.defineProperty(exports, "createStructuredOutputChainFromZod", { enumerable: true, get: function () { return structured_output_js_1.createStructuredOutputChainFromZod; } });
+var base_js_1 = require("./base.cjs");
+Object.defineProperty(exports, "createStructuredOutputRunnable", { enumerable: true, get: function () { return base_js_1.createStructuredOutputRunnable; } });
+Object.defineProperty(exports, "createOpenAIFnRunnable", { enumerable: true, get: function () { return base_js_1.createOpenAIFnRunnable; } });

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

@@ -2,3 +2,4 @@ export { createExtractionChain, createExtractionChainFromZod, } from "./extracti
 export { type TaggingChainOptions, createTaggingChain, createTaggingChainFromZod, } from "./tagging.js";
 export { type OpenAPIChainOptions, createOpenAPIChain } from "./openapi.js";
 export { type StructuredOutputChainInput, createStructuredOutputChain, createStructuredOutputChainFromZod, } from "./structured_output.js";
+export { createStructuredOutputRunnable, createOpenAIFnRunnable, } from "./base.js";

package/dist/chains/openai_functions/index.js

@@ -2,3 +2,4 @@ export { createExtractionChain, createExtractionChainFromZod, } from "./extracti
 export { createTaggingChain, createTaggingChainFromZod, } from "./tagging.js";
 export { createOpenAPIChain } from "./openapi.js";
 export { createStructuredOutputChain, createStructuredOutputChainFromZod, } from "./structured_output.js";
+export { createStructuredOutputRunnable, createOpenAIFnRunnable, } from "./base.js";

package/dist/output_parsers/openai_functions.d.ts

@@ -31,7 +31,7 @@ export declare class OutputFunctionsParser extends BaseLLMOutputParser<string> {
  * Class for parsing the output of an LLM into a JSON object. Uses an
  * instance of `OutputFunctionsParser` to parse the output.
  */
-export declare class JsonOutputFunctionsParser extends BaseCumulativeTransformOutputParser<object> {
+export declare class JsonOutputFunctionsParser<Output extends object = object> extends BaseCumulativeTransformOutputParser<Output> {
     static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
@@ -41,15 +41,15 @@ export declare class JsonOutputFunctionsParser extends BaseCumulativeTransformOu
         argsOnly?: boolean;
     } & BaseCumulativeTransformOutputParserInput);
     protected _diff(prev: unknown | undefined, next: unknown): JSONPatchOperation[] | undefined;
-    parsePartialResult(generations: ChatGeneration[]): Promise<object | undefined>;
+    parsePartialResult(generations: ChatGeneration[]): Promise<Output | undefined>;
     /**
      * Parses the output and returns a JSON object. If `argsOnly` is true,
      * only the arguments of the function call are returned.
      * @param generations The output of the LLM to parse.
      * @returns A JSON object representation of the function call or its arguments.
      */
-    parseResult(generations: Generation[] | ChatGeneration[]): Promise<object>;
-    parse(text: string): Promise<object>;
+    parseResult(generations: Generation[] | ChatGeneration[]): Promise<Output>;
+    parse(text: string): Promise<Output>;
     getFormatInstructions(): string;
 }
 /**
@@ -61,7 +61,7 @@ export declare class JsonKeyOutputFunctionsParser<T = object> extends BaseLLMOut
     static lc_name(): string;
     lc_namespace: string[];
     lc_serializable: boolean;
-    outputParser: JsonOutputFunctionsParser;
+    outputParser: JsonOutputFunctionsParser<object>;
     attrName: string;
     constructor(fields: {
         attrName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langchain",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Typescript bindings for langchain",
   "type": "module",
   "engines": {