@langchain/core 0.1.39 → 0.1.41

package/dist/language_models/base.d.ts

@@ -106,6 +106,13 @@ export interface BaseFunctionCallOptions extends BaseLanguageModelCallOptions {
     functions?: FunctionDefinition[];
 }
 export type BaseLanguageModelInput = BasePromptValueInterface | string | BaseMessageLike[];
+export type StructuredOutputType = z.infer<z.ZodObject<any, any, any, any>>;
+export type StructuredOutputMethodParams<RunOutput extends Record<string, any> = Record<string, any>, IncludeRaw extends boolean = false> = {
+    schema: z.ZodType<RunOutput> | Record<string, any>;
+    name?: string;
+    method?: "functionCalling" | "jsonMode";
+    includeRaw?: IncludeRaw;
+};
 export interface BaseLanguageModelInterface<RunOutput = any, CallOptions extends BaseLanguageModelCallOptions = BaseLanguageModelCallOptions> extends RunnableInterface<BaseLanguageModelInput, RunOutput, CallOptions> {
     get callKeys(): string[];
     generatePrompt(promptValues: BasePromptValueInterface[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
@@ -177,26 +184,16 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
      * Load an LLM from a json-like object describing it.
      */
     static deserialize(_data: SerializedLLM): Promise<BaseLanguageModel>;
-    withStructuredOutput?<RunInput = BaseLanguageModelInput, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, method, includeRaw, }: {
-        schema: z.ZodEffects<RunOutput> | Record<string, any>;
-        name: string;
-        method?: "functionCalling" | "jsonMode";
-        includeRaw: true;
-    }): Runnable<RunInput, {
+    withStructuredOutput?<RunOutput extends Record<string, any> = Record<string, any>>({ schema, name, method, includeRaw, }: StructuredOutputMethodParams<RunOutput, false>): Runnable<BaseLanguageModelInput, RunOutput>;
+    withStructuredOutput?<RunOutput extends Record<string, any> = Record<string, any>>({ schema, name, method, includeRaw, }: StructuredOutputMethodParams<RunOutput, true>): Runnable<BaseLanguageModelInput, {
         raw: BaseMessage;
         parsed: RunOutput;
     }>;
-    withStructuredOutput?<RunInput = BaseLanguageModelInput, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, method, includeRaw, }: {
-        schema: z.ZodEffects<RunOutput> | Record<string, any>;
-        name: string;
-        method?: "functionCalling" | "jsonMode";
-        includeRaw?: false;
-    }): Runnable<RunInput, RunOutput>;
     /**
      * Model wrapper that returns outputs formatted to match the given schema.
      *
      * @template {BaseLanguageModelInput} RunInput The input type for the Runnable, expected to be the same input for the LLM.
-     * @template {z.ZodObject<any, any, any, any>} RunOutput The output type for the Runnable, expected to be a Zod schema object for structured output validation.
+     * @template {Record<string, any>} RunOutput The output type for the Runnable, expected to be a Zod schema object for structured output validation.
      *
      * @param {z.ZodEffects<RunOutput>} schema The schema for the structured output. Either as a Zod schema or a valid JSON schema object.
      * @param {string} name The name of the function to call.
@@ -204,7 +201,7 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
      * @param {boolean | undefined} [includeRaw=false] Whether to include the raw output in the result. Defaults to false.
      * @returns {Runnable<RunInput, RunOutput> | Runnable<RunInput, { raw: BaseMessage; parsed: RunOutput }>} A new runnable that calls the LLM with structured output.
      */
-    withStructuredOutput?<RunInput extends BaseLanguageModelInput = BaseLanguageModelInput, RunOutput extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>>({ schema, name, 
+    withStructuredOutput?<RunOutput extends Record<string, any> = Record<string, any>>({ schema, name, 
     /**
      * @default functionCalling
      */
@@ -212,12 +209,7 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
     /**
      * @default false
      */
-    includeRaw, }: {
-        schema: z.ZodEffects<RunOutput> | Record<string, any>;
-        name: string;
-        method?: "functionCalling" | "jsonMode";
-        includeRaw?: boolean;
-    }): Runnable<RunInput, RunOutput> | Runnable<RunInput, {
+    includeRaw, }: StructuredOutputMethodParams<RunOutput>): Runnable<BaseLanguageModelInput, RunOutput> | Runnable<BaseLanguageModelInput, {
         raw: BaseMessage;
         parsed: RunOutput;
     }>;

package/dist/retrievers.cjs

@@ -50,7 +50,7 @@ class BaseRetriever extends base_js_1.Runnable {
         throw new Error("Not implemented!");
     }
     async invoke(input, options) {
-        return this.getRelevantDocuments(input, options);
+        return this.getRelevantDocuments(input, (0, config_js_1.ensureConfig)(options));
     }
     /**
      * Main method used to retrieve relevant documents. It takes a query

package/dist/retrievers.d.ts

@@ -11,15 +11,15 @@ export interface BaseRetrieverInput {
     metadata?: Record<string, unknown>;
     verbose?: boolean;
 }
-export interface BaseRetrieverInterface extends RunnableInterface<string, DocumentInterface[]> {
-    getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<DocumentInterface[]>;
+export interface BaseRetrieverInterface<Metadata extends Record<string, any> = Record<string, any>> extends RunnableInterface<string, DocumentInterface<Metadata>[]> {
+    getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<DocumentInterface<Metadata>[]>;
 }
 /**
  * Abstract base class for a Document retrieval system. A retrieval system
  * is defined as something that can take string queries and return the
  * most 'relevant' Documents from some source.
  */
-export declare abstract class BaseRetriever extends Runnable<string, DocumentInterface[]> implements BaseRetrieverInterface {
+export declare abstract class BaseRetriever<Metadata extends Record<string, any> = Record<string, any>> extends Runnable<string, DocumentInterface<Metadata>[]> implements BaseRetrieverInterface {
     callbacks?: Callbacks;
     tags?: string[];
     metadata?: Record<string, unknown>;
@@ -30,8 +30,8 @@ export declare abstract class BaseRetriever extends Runnable<string, DocumentInt
      * changes to people currently using subclassed custom retrievers.
      * Change it on next major release.
      */
-    _getRelevantDocuments(_query: string, _callbacks?: CallbackManagerForRetrieverRun): Promise<DocumentInterface[]>;
-    invoke(input: string, options?: RunnableConfig): Promise<DocumentInterface[]>;
+    _getRelevantDocuments(_query: string, _callbacks?: CallbackManagerForRetrieverRun): Promise<DocumentInterface<Metadata>[]>;
+    invoke(input: string, options?: RunnableConfig): Promise<DocumentInterface<Metadata>[]>;
     /**
      * Main method used to retrieve relevant documents. It takes a query
      * string and an optional configuration object, and returns a promise that
@@ -42,5 +42,5 @@ export declare abstract class BaseRetriever extends Runnable<string, DocumentInt
      * @param config Optional configuration object for the retrieval process.
      * @returns A promise that resolves to an array of `Document` objects.
      */
-    getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<DocumentInterface[]>;
+    getRelevantDocuments(query: string, config?: Callbacks | BaseCallbackConfig): Promise<DocumentInterface<Metadata>[]>;
 }

package/dist/retrievers.js

@@ -47,7 +47,7 @@ export class BaseRetriever extends Runnable {
         throw new Error("Not implemented!");
     }
     async invoke(input, options) {
-        return this.getRelevantDocuments(input, options);
+        return this.getRelevantDocuments(input, ensureConfig(options));
     }
     /**
      * Main method used to retrieve relevant documents. It takes a query

package/dist/runnables/router.cjs

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RouterRunnable = void 0;
 const base_js_1 = require("./base.cjs");
+const config_js_1 = require("./config.cjs");
 /**
  * A runnable that routes to a set of runnables based on Input['key'].
  * Returns the output of the selected runnable.
@@ -38,7 +39,7 @@ class RouterRunnable extends base_js_1.Runnable {
         if (runnable === undefined) {
             throw new Error(`No runnable associated with key "${key}".`);
         }
-        return runnable.invoke(actualInput, options);
+        return runnable.invoke(actualInput, (0, config_js_1.ensureConfig)(options));
     }
     async batch(inputs, options, batchOptions) {
         const keys = inputs.map((input) => input.key);

package/dist/runnables/router.d.ts

@@ -1,6 +1,6 @@
 import { Runnable, type RunnableBatchOptions } from "./base.js";
 import { IterableReadableStream } from "../utils/stream.js";
-import type { RunnableConfig } from "./config.js";
+import { type RunnableConfig } from "./config.js";
 export type RouterInput = {
     key: string;
     input: any;

package/dist/runnables/router.js

@@ -1,4 +1,5 @@
 import { Runnable } from "./base.js";
+import { ensureConfig } from "./config.js";
 /**
  * A runnable that routes to a set of runnables based on Input['key'].
  * Returns the output of the selected runnable.
@@ -35,7 +36,7 @@ export class RouterRunnable extends Runnable {
         if (runnable === undefined) {
             throw new Error(`No runnable associated with key "${key}".`);
         }
-        return runnable.invoke(actualInput, options);
+        return runnable.invoke(actualInput, ensureConfig(options));
     }
     async batch(inputs, options, batchOptions) {
         const keys = inputs.map((input) => input.key);

package/dist/utils/beta_warning.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.betaWarning = void 0;
+/**
+ * Util function for logging a warning when a method is called.
+ * @param {string} func The name of the function that is in beta.
+ */
+function betaWarning(func) {
+    console.warn(`The function '${func}' is in beta. It is actively being worked on, so the API may change.`);
+}
+exports.betaWarning = betaWarning;

package/dist/utils/beta_warning.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Util function for logging a warning when a method is called.
+ * @param {string} func The name of the function that is in beta.
+ */
+export declare function betaWarning(func: string): void;

package/dist/utils/beta_warning.js

@@ -0,0 +1,7 @@
+/**
+ * Util function for logging a warning when a method is called.
+ * @param {string} func The name of the function that is in beta.
+ */
+export function betaWarning(func) {
+    console.warn(`The function '${func}' is in beta. It is actively being worked on, so the API may change.`);
+}

package/dist/utils/testing/index.cjs

@@ -311,6 +311,12 @@ class FakeListChatModel extends chat_models_js_1.BaseChatModel {
             this.i = 0;
         }
     }
+    withStructuredOutput(_params) {
+        return base_js_2.RunnableLambda.from(async (input) => {
+            const message = await this.invoke(input);
+            return JSON.parse(message.content);
+        });
+    }
 }
 exports.FakeListChatModel = FakeListChatModel;
 class FakeChatMessageHistory extends chat_history_js_1.BaseChatMessageHistory {

package/dist/utils/testing/index.d.ts

@@ -12,6 +12,7 @@ import { Runnable } from "../../runnables/base.js";
 import { StructuredTool, ToolParams } from "../../tools.js";
 import { BaseTracer, Run } from "../../tracers/base.js";
 import { Embeddings, EmbeddingsParams } from "../../embeddings.js";
+import { StructuredOutputMethodParams, BaseLanguageModelInput } from "../../language_models/base.js";
 /**
  * Parser for comma-separated values. It splits the input text by commas
  * and trims the resulting values.
@@ -113,6 +114,11 @@ export declare class FakeListChatModel extends BaseChatModel {
     _createResponseChunk(text: string): ChatGenerationChunk;
     _currentResponse(): string;
     _incrementResponse(): void;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(_params: StructuredOutputMethodParams<RunOutput, false>): Runnable<BaseLanguageModelInput, RunOutput>;
+    withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(_params: StructuredOutputMethodParams<RunOutput, true>): Runnable<BaseLanguageModelInput, {
+        raw: BaseMessage;
+        parsed: RunOutput;
+    }>;
 }
 export declare class FakeChatMessageHistory extends BaseChatMessageHistory {
     lc_namespace: string[];

package/dist/utils/testing/index.js

@@ -6,7 +6,7 @@ import { AIMessage, AIMessageChunk, HumanMessage, } from "../../messages/index.j
 import { BaseOutputParser } from "../../output_parsers/base.js";
 import { ChatGenerationChunk, } from "../../outputs.js";
 import { BaseRetriever } from "../../retrievers.js";
-import { Runnable } from "../../runnables/base.js";
+import { Runnable, RunnableLambda } from "../../runnables/base.js";
 import { StructuredTool } from "../../tools.js";
 import { BaseTracer } from "../../tracers/base.js";
 import { Embeddings } from "../../embeddings.js";
@@ -302,6 +302,12 @@ export class FakeListChatModel extends BaseChatModel {
             this.i = 0;
         }
     }
+    withStructuredOutput(_params) {
+        return RunnableLambda.from(async (input) => {
+            const message = await this.invoke(input);
+            return JSON.parse(message.content);
+        });
+    }
 }
 export class FakeChatMessageHistory extends BaseChatMessageHistory {
     constructor() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.1.39",
+  "version": "0.1.41",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {
@@ -524,6 +524,15 @@
       "import": "./utils/types.js",
       "require": "./utils/types.cjs"
     },
+    "./utils/beta_warning": {
+      "types": {
+        "import": "./utils/beta_warning.d.ts",
+        "require": "./utils/beta_warning.d.cts",
+        "default": "./utils/beta_warning.d.ts"
+      },
+      "import": "./utils/beta_warning.js",
+      "require": "./utils/beta_warning.cjs"
+    },
     "./vectorstores": {
       "types": {
         "import": "./vectorstores.d.ts",
@@ -729,6 +738,10 @@
     "utils/types.js",
     "utils/types.d.ts",
     "utils/types.d.cts",
+    "utils/beta_warning.cjs",
+    "utils/beta_warning.js",
+    "utils/beta_warning.d.ts",
+    "utils/beta_warning.d.cts",
     "vectorstores.cjs",
     "vectorstores.js",
     "vectorstores.d.ts",

package/utils/beta_warning.cjs

@@ -0,0 +1 @@
+module.exports = require('../dist/utils/beta_warning.cjs');

package/utils/beta_warning.d.cts

@@ -0,0 +1 @@
+export * from '../dist/utils/beta_warning.js'

package/utils/beta_warning.d.ts

@@ -0,0 +1 @@
+export * from '../dist/utils/beta_warning.js'

package/utils/beta_warning.js

@@ -0,0 +1 @@
+export * from '../dist/utils/beta_warning.js'