@langchain/core 0.1.8 → 0.1.9-rc.0

package/dist/language_models/base.d.ts

@@ -105,7 +105,13 @@ export interface BaseLanguageModelInterface<RunOutput = any, CallOptions extends
     CallOptions: CallOptions;
     get callKeys(): string[];
     generatePrompt(promptValues: BasePromptValueInterface[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
+    /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     */
     predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
+    /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     */
     predictMessages(messages: BaseMessage[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
     _modelType(): string;
     _llmType(): string;
@@ -135,7 +141,13 @@ export declare abstract class BaseLanguageModel<RunOutput = any, CallOptions ext
     cache?: BaseCache;
     constructor({ callbacks, callbackManager, ...params }: BaseLanguageModelParams);
     abstract generatePrompt(promptValues: BasePromptValueInterface[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
+    /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     */
     abstract predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
+    /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     */
     abstract predictMessages(messages: BaseMessage[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
     abstract _modelType(): string;
     abstract _llmType(): string;

package/dist/language_models/chat_models.cjs

@@ -286,6 +286,8 @@ class BaseChatModel extends base_js_1.BaseLanguageModel {
         return this.generate(promptMessages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -298,6 +300,8 @@ class BaseChatModel extends base_js_1.BaseLanguageModel {
         return generations[0][0].message;
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model with a prompt value.
      * @param promptValue The value of the prompt.
      * @param options The call options or an array of stop sequences.
@@ -309,6 +313,8 @@ class BaseChatModel extends base_js_1.BaseLanguageModel {
         return this.call(promptMessages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on the input messages.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -319,6 +325,8 @@ class BaseChatModel extends base_js_1.BaseLanguageModel {
         return this.call(messages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on a text input.
      * @param text The text input.
      * @param options The call options or an array of stop sequences.

package/dist/language_models/chat_models.d.ts

@@ -93,6 +93,8 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
     generatePrompt(promptValues: BasePromptValueInterface[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
     abstract _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -101,6 +103,8 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
      */
     call(messages: BaseMessageLike[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model with a prompt value.
      * @param promptValue The value of the prompt.
      * @param options The call options or an array of stop sequences.
@@ -109,6 +113,8 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
      */
     callPrompt(promptValue: BasePromptValueInterface, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on the input messages.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -117,6 +123,8 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
      */
     predictMessages(messages: BaseMessage[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on a text input.
      * @param text The text input.
      * @param options The call options or an array of stop sequences.

package/dist/language_models/chat_models.js

@@ -282,6 +282,8 @@ export class BaseChatModel extends BaseLanguageModel {
         return this.generate(promptMessages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -294,6 +296,8 @@ export class BaseChatModel extends BaseLanguageModel {
         return generations[0][0].message;
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Makes a single call to the chat model with a prompt value.
      * @param promptValue The value of the prompt.
      * @param options The call options or an array of stop sequences.
@@ -305,6 +309,8 @@ export class BaseChatModel extends BaseLanguageModel {
         return this.call(promptMessages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on the input messages.
      * @param messages An array of BaseMessage instances.
      * @param options The call options or an array of stop sequences.
@@ -315,6 +321,8 @@ export class BaseChatModel extends BaseLanguageModel {
         return this.call(messages, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * Predicts the next message based on a text input.
      * @param text The text input.
      * @param options The call options or an array of stop sequences.

package/dist/language_models/llms.cjs

@@ -6,7 +6,7 @@ const outputs_js_1 = require("../outputs.cjs");
 const manager_js_1 = require("../callbacks/manager.cjs");
 const base_js_1 = require("./base.cjs");
 /**
- * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
+ * LLM Wrapper. Takes in a prompt (or prompts) and returns a string.
  */
 class BaseLLM extends base_js_1.BaseLanguageModel {
     constructor({ concurrency, ...rest }) {
@@ -252,6 +252,7 @@ class BaseLLM extends base_js_1.BaseLanguageModel {
         return { generations, llmOutput };
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
      * Convenience wrapper for {@link generate} that takes in a single string prompt and returns a single string output.
      */
     async call(prompt, options, callbacks) {
@@ -259,6 +260,8 @@ class BaseLLM extends base_js_1.BaseLanguageModel {
         return generations[0][0].text;
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method is similar to `call`, but it's used for making predictions
      * based on the input text.
      * @param text Input text for the prediction.
@@ -270,6 +273,8 @@ class BaseLLM extends base_js_1.BaseLanguageModel {
         return this.call(text, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method takes a list of messages, options, and callbacks, and
      * returns a predicted message.
      * @param messages A list of messages for the prediction.

package/dist/language_models/llms.d.ts

@@ -25,7 +25,7 @@ interface LLMGenerateCachedParameters<T extends BaseLLM<CallOptions>, CallOption
     handledOptions: RunnableConfig;
 }
 /**
- * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
+ * LLM Wrapper. Takes in a prompt (or prompts) and returns a string.
  */
 export declare abstract class BaseLLM<CallOptions extends BaseLLMCallOptions = BaseLLMCallOptions> extends BaseLanguageModel<string, CallOptions> {
     ParsedCallOptions: Omit<CallOptions, keyof RunnableConfig & "timeout">;
@@ -71,10 +71,13 @@ export declare abstract class BaseLLM<CallOptions extends BaseLLMCallOptions = B
      */
     generate(prompts: string[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
      * Convenience wrapper for {@link generate} that takes in a single string prompt and returns a single string output.
      */
     call(prompt: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method is similar to `call`, but it's used for making predictions
      * based on the input text.
      * @param text Input text for the prediction.
@@ -84,6 +87,8 @@ export declare abstract class BaseLLM<CallOptions extends BaseLLMCallOptions = B
      */
     predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method takes a list of messages, options, and callbacks, and
      * returns a predicted message.
      * @param messages A list of messages for the prediction.

package/dist/language_models/llms.js

@@ -3,7 +3,7 @@ import { RUN_KEY, GenerationChunk, } from "../outputs.js";
 import { CallbackManager, } from "../callbacks/manager.js";
 import { BaseLanguageModel, } from "./base.js";
 /**
- * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
+ * LLM Wrapper. Takes in a prompt (or prompts) and returns a string.
  */
 export class BaseLLM extends BaseLanguageModel {
     constructor({ concurrency, ...rest }) {
@@ -249,6 +249,7 @@ export class BaseLLM extends BaseLanguageModel {
         return { generations, llmOutput };
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
      * Convenience wrapper for {@link generate} that takes in a single string prompt and returns a single string output.
      */
     async call(prompt, options, callbacks) {
@@ -256,6 +257,8 @@ export class BaseLLM extends BaseLanguageModel {
         return generations[0][0].text;
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method is similar to `call`, but it's used for making predictions
      * based on the input text.
      * @param text Input text for the prediction.
@@ -267,6 +270,8 @@ export class BaseLLM extends BaseLanguageModel {
         return this.call(text, options, callbacks);
     }
     /**
+     * @deprecated Use .invoke() instead. Will be removed in 0.2.0.
+     *
      * This method takes a list of messages, options, and callbacks, and
      * returns a predicted message.
      * @param messages A list of messages for the prediction.

package/dist/runnables/history.cjs

@@ -4,6 +4,70 @@ exports.RunnableWithMessageHistory = void 0;
 const index_js_1 = require("../messages/index.cjs");
 const base_js_1 = require("./base.cjs");
 const passthrough_js_1 = require("./passthrough.cjs");
+/**
+ * Wraps a LCEL chain and manages history. It appends input messages
+ * and chain outputs as history, and adds the current history messages to
+ * the chain input.
+ * @example
+ * ```typescript
+ * // yarn add @langchain/anthropic @langchain/community @upstash/redis
+ *
+ * import {
+ *   ChatPromptTemplate,
+ *   MessagesPlaceholder,
+ * } from "@langchain/core/prompts";
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ * import { UpstashRedisChatMessageHistory } from "@langchain/community/stores/message/upstash_redis";
+ * // For demos, you can also use an in-memory store:
+ * // import { ChatMessageHistory } from "langchain/stores/message/in_memory";
+ *
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["system", "You're an assistant who's good at {ability}"],
+ *   new MessagesPlaceholder("history"),
+ *   ["human", "{question}"],
+ * ]);
+ *
+ * const chain = prompt.pipe(new ChatAnthropic({}));
+ *
+ * const chainWithHistory = new RunnableWithMessageHistory({
+ *   runnable: chain,
+ *   getMessageHistory: (sessionId) =>
+ *     new UpstashRedisChatMessageHistory({
+ *       sessionId,
+ *       config: {
+ *         url: process.env.UPSTASH_REDIS_REST_URL!,
+ *         token: process.env.UPSTASH_REDIS_REST_TOKEN!,
+ *       },
+ *     }),
+ *   inputMessagesKey: "question",
+ *   historyMessagesKey: "history",
+ * });
+ *
+ * const result = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What does cosine mean?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ *
+ * const result2 = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What's its inverse?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ * ```
+ */
 class RunnableWithMessageHistory extends base_js_1.RunnableBinding {
     constructor(fields) {
         let historyChain = new base_js_1.RunnableLambda({

package/dist/runnables/history.d.ts

@@ -12,6 +12,70 @@ export interface RunnableWithMessageHistoryInputs<RunInput, RunOutput> extends O
     historyMessagesKey?: string;
     config?: RunnableConfig;
 }
+/**
+ * Wraps a LCEL chain and manages history. It appends input messages
+ * and chain outputs as history, and adds the current history messages to
+ * the chain input.
+ * @example
+ * ```typescript
+ * // yarn add @langchain/anthropic @langchain/community @upstash/redis
+ *
+ * import {
+ *   ChatPromptTemplate,
+ *   MessagesPlaceholder,
+ * } from "@langchain/core/prompts";
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ * import { UpstashRedisChatMessageHistory } from "@langchain/community/stores/message/upstash_redis";
+ * // For demos, you can also use an in-memory store:
+ * // import { ChatMessageHistory } from "langchain/stores/message/in_memory";
+ *
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["system", "You're an assistant who's good at {ability}"],
+ *   new MessagesPlaceholder("history"),
+ *   ["human", "{question}"],
+ * ]);
+ *
+ * const chain = prompt.pipe(new ChatAnthropic({}));
+ *
+ * const chainWithHistory = new RunnableWithMessageHistory({
+ *   runnable: chain,
+ *   getMessageHistory: (sessionId) =>
+ *     new UpstashRedisChatMessageHistory({
+ *       sessionId,
+ *       config: {
+ *         url: process.env.UPSTASH_REDIS_REST_URL!,
+ *         token: process.env.UPSTASH_REDIS_REST_TOKEN!,
+ *       },
+ *     }),
+ *   inputMessagesKey: "question",
+ *   historyMessagesKey: "history",
+ * });
+ *
+ * const result = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What does cosine mean?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ *
+ * const result2 = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What's its inverse?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ * ```
+ */
 export declare class RunnableWithMessageHistory<RunInput, RunOutput> extends RunnableBinding<RunInput, RunOutput> {
     runnable: Runnable<RunInput, RunOutput>;
     inputMessagesKey?: string;

package/dist/runnables/history.js

@@ -1,6 +1,70 @@
 import { AIMessage, HumanMessage, isBaseMessage, } from "../messages/index.js";
 import { RunnableBinding, RunnableLambda, } from "./base.js";
 import { RunnablePassthrough } from "./passthrough.js";
+/**
+ * Wraps a LCEL chain and manages history. It appends input messages
+ * and chain outputs as history, and adds the current history messages to
+ * the chain input.
+ * @example
+ * ```typescript
+ * // yarn add @langchain/anthropic @langchain/community @upstash/redis
+ *
+ * import {
+ *   ChatPromptTemplate,
+ *   MessagesPlaceholder,
+ * } from "@langchain/core/prompts";
+ * import { ChatAnthropic } from "@langchain/anthropic";
+ * import { UpstashRedisChatMessageHistory } from "@langchain/community/stores/message/upstash_redis";
+ * // For demos, you can also use an in-memory store:
+ * // import { ChatMessageHistory } from "langchain/stores/message/in_memory";
+ *
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   ["system", "You're an assistant who's good at {ability}"],
+ *   new MessagesPlaceholder("history"),
+ *   ["human", "{question}"],
+ * ]);
+ *
+ * const chain = prompt.pipe(new ChatAnthropic({}));
+ *
+ * const chainWithHistory = new RunnableWithMessageHistory({
+ *   runnable: chain,
+ *   getMessageHistory: (sessionId) =>
+ *     new UpstashRedisChatMessageHistory({
+ *       sessionId,
+ *       config: {
+ *         url: process.env.UPSTASH_REDIS_REST_URL!,
+ *         token: process.env.UPSTASH_REDIS_REST_TOKEN!,
+ *       },
+ *     }),
+ *   inputMessagesKey: "question",
+ *   historyMessagesKey: "history",
+ * });
+ *
+ * const result = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What does cosine mean?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ *
+ * const result2 = await chainWithHistory.invoke(
+ *   {
+ *     ability: "math",
+ *     question: "What's its inverse?",
+ *   },
+ *   {
+ *     configurable: {
+ *       sessionId: "some_string_identifying_a_user",
+ *     },
+ *   }
+ * );
+ * ```
+ */
 export class RunnableWithMessageHistory extends RunnableBinding {
     constructor(fields) {
         let historyChain = new RunnableLambda({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/core",
-  "version": "0.1.8",
+  "version": "0.1.9-rc.0",
   "description": "Core LangChain.js abstractions and schemas",
   "type": "module",
   "engines": {