langchain 0.0.191 → 0.0.193

package/dist/llms/googlevertexai/web.cjs

@@ -12,6 +12,18 @@ const common_js_1 = require("./common.cjs");
  * functions where you do not have access to the file system. It supports passing
  * service account credentials directly as a "GOOGLE_VERTEX_AI_WEB_CREDENTIALS"
  * environment variable or directly as "authOptions.credentials".
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const stream = await model.stream(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * for await (const chunk of stream) {
+ *   console.log(chunk);
+ * }
+ * ```
  */
 class GoogleVertexAI extends common_js_1.BaseGoogleVertexAI {
     static lc_name() {

package/dist/llms/googlevertexai/web.d.ts

@@ -14,6 +14,18 @@ export interface GoogleVertexAITextInput extends GoogleVertexAIBaseLLMInput<WebG
  * functions where you do not have access to the file system. It supports passing
  * service account credentials directly as a "GOOGLE_VERTEX_AI_WEB_CREDENTIALS"
  * environment variable or directly as "authOptions.credentials".
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const stream = await model.stream(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * for await (const chunk of stream) {
+ *   console.log(chunk);
+ * }
+ * ```
  */
 export declare class GoogleVertexAI extends BaseGoogleVertexAI<WebGoogleAuthOptions> {
     static lc_name(): string;

package/dist/llms/googlevertexai/web.js

@@ -9,6 +9,18 @@ import { BaseGoogleVertexAI } from "./common.js";
  * functions where you do not have access to the file system. It supports passing
  * service account credentials directly as a "GOOGLE_VERTEX_AI_WEB_CREDENTIALS"
  * environment variable or directly as "authOptions.credentials".
+ * @example
+ * ```typescript
+ * const model = new GoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const stream = await model.stream(
+ *   "What would be a good company name for a company that makes colorful socks?",
+ * );
+ * for await (const chunk of stream) {
+ *   console.log(chunk);
+ * }
+ * ```
  */
 export class GoogleVertexAI extends BaseGoogleVertexAI {
     static lc_name() {

package/dist/llms/hf.cjs

@@ -6,6 +6,19 @@ const base_js_1 = require("./base.cjs");
 /**
  * Class implementing the Large Language Model (LLM) interface using the
  * Hugging Face Inference API for text generation.
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceInference({
+ *   model: "gpt2",
+ *   temperature: 0.7,
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 class HuggingFaceInference extends base_js_1.LLM {
     get lc_secrets() {

package/dist/llms/hf.d.ts

@@ -26,6 +26,19 @@ export interface HFInput {
 /**
  * Class implementing the Large Language Model (LLM) interface using the
  * Hugging Face Inference API for text generation.
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceInference({
+ *   model: "gpt2",
+ *   temperature: 0.7,
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class HuggingFaceInference extends LLM implements HFInput {
     get lc_secrets(): {

package/dist/llms/hf.js

@@ -3,6 +3,19 @@ import { LLM } from "./base.js";
 /**
  * Class implementing the Large Language Model (LLM) interface using the
  * Hugging Face Inference API for text generation.
+ * @example
+ * ```typescript
+ * const model = new HuggingFaceInference({
+ *   model: "gpt2",
+ *   temperature: 0.7,
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class HuggingFaceInference extends LLM {
     get lc_secrets() {

package/dist/llms/ollama.cjs

@@ -7,6 +7,25 @@ const index_js_1 = require("../schema/index.cjs");
 /**
  * Class that represents the Ollama language model. It extends the base
  * LLM class and implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const ollama = new Ollama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ * });
+ *
+ * // Streaming translation from English to German
+ * const stream = await ollama.stream(
+ *   `Translate "I love programming" into German.`
+ * );
+ *
+ * const chunks = [];
+ * for await (const chunk of stream) {
+ *   chunks.push(chunk);
+ * }
+ *
+ * console.log(chunks.join(""));
+ * ```
  */
 class Ollama extends base_js_1.LLM {
     static lc_name() {

package/dist/llms/ollama.d.ts

@@ -6,6 +6,25 @@ import type { StringWithAutocomplete } from "../util/types.js";
 /**
  * Class that represents the Ollama language model. It extends the base
  * LLM class and implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const ollama = new Ollama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ * });
+ *
+ * // Streaming translation from English to German
+ * const stream = await ollama.stream(
+ *   `Translate "I love programming" into German.`
+ * );
+ *
+ * const chunks = [];
+ * for await (const chunk of stream) {
+ *   chunks.push(chunk);
+ * }
+ *
+ * console.log(chunks.join(""));
+ * ```
  */
 export declare class Ollama extends LLM<OllamaCallOptions> implements OllamaInput {
     static lc_name(): string;

package/dist/llms/ollama.js

@@ -4,6 +4,25 @@ import { GenerationChunk } from "../schema/index.js";
 /**
  * Class that represents the Ollama language model. It extends the base
  * LLM class and implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const ollama = new Ollama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ * });
+ *
+ * // Streaming translation from English to German
+ * const stream = await ollama.stream(
+ *   `Translate "I love programming" into German.`
+ * );
+ *
+ * const chunks = [];
+ * for await (const chunk of stream) {
+ *   chunks.push(chunk);
+ * }
+ *
+ * console.log(chunks.join(""));
+ * ```
  */
 export class Ollama extends LLM {
     static lc_name() {

package/dist/llms/openai-chat.cjs

@@ -29,6 +29,23 @@ const openai_js_1 = require("../util/openai.cjs");
  * @augments BaseLLM
  * @augments OpenAIInput
  * @augments AzureOpenAIChatInput
+ * @example
+ * ```typescript
+ * const model = new OpenAIChat({
+ *   prefixMessages: [
+ *     {
+ *       role: "system",
+ *       content: "You are a helpful assistant that answers in pirate language",
+ *     },
+ *   ],
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 class OpenAIChat extends base_js_1.LLM {
     static lc_name() {

package/dist/llms/openai-chat.d.ts

@@ -33,6 +33,23 @@ export interface OpenAIChatCallOptions extends OpenAICallOptions {
  * @augments BaseLLM
  * @augments OpenAIInput
  * @augments AzureOpenAIChatInput
+ * @example
+ * ```typescript
+ * const model = new OpenAIChat({
+ *   prefixMessages: [
+ *     {
+ *       role: "system",
+ *       content: "You are a helpful assistant that answers in pirate language",
+ *     },
+ *   ],
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class OpenAIChat extends LLM<OpenAIChatCallOptions> implements OpenAIChatInput, AzureOpenAIInput {
     static lc_name(): string;

package/dist/llms/openai-chat.js

@@ -26,6 +26,23 @@ import { wrapOpenAIClientError } from "../util/openai.js";
  * @augments BaseLLM
  * @augments OpenAIInput
  * @augments AzureOpenAIChatInput
+ * @example
+ * ```typescript
+ * const model = new OpenAIChat({
+ *   prefixMessages: [
+ *     {
+ *       role: "system",
+ *       content: "You are a helpful assistant that answers in pirate language",
+ *     },
+ *   ],
+ *   maxTokens: 50,
+ * });
+ *
+ * const res = await model.call(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class OpenAIChat extends LLM {
     static lc_name() {

package/dist/llms/openai.cjs

@@ -28,6 +28,20 @@ const openai_js_1 = require("../util/openai.cjs");
  * https://platform.openai.com/docs/api-reference/completions/create |
  * `openai.createCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * const model = new OpenAI({
+ *   modelName: "gpt-4",
+ *   temperature: 0.7,
+ *   maxTokens: 1000,
+ *   maxRetries: 5,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 class OpenAI extends base_js_1.BaseLLM {
     static lc_name() {

package/dist/llms/openai.d.ts

@@ -21,6 +21,20 @@ export type { AzureOpenAIInput, OpenAICallOptions, OpenAIInput };
  * https://platform.openai.com/docs/api-reference/completions/create |
  * `openai.createCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * const model = new OpenAI({
+ *   modelName: "gpt-4",
+ *   temperature: 0.7,
+ *   maxTokens: 1000,
+ *   maxRetries: 5,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class OpenAI<CallOptions extends OpenAICallOptions = OpenAICallOptions> extends BaseLLM<CallOptions> implements OpenAIInput, AzureOpenAIInput {
     static lc_name(): string;

package/dist/llms/openai.js

@@ -25,6 +25,20 @@ import { wrapOpenAIClientError } from "../util/openai.js";
  * https://platform.openai.com/docs/api-reference/completions/create |
  * `openai.createCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * const model = new OpenAI({
+ *   modelName: "gpt-4",
+ *   temperature: 0.7,
+ *   maxTokens: 1000,
+ *   maxRetries: 5,
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class OpenAI extends BaseLLM {
     static lc_name() {

package/dist/llms/portkey.cjs

@@ -51,6 +51,30 @@ function getPortkeySession(options = {}) {
     return session;
 }
 exports.getPortkeySession = getPortkeySession;
+/**
+ * @example
+ * ```typescript
+ * const model = new Portkey({
+ *   mode: "single",
+ *   llms: [
+ *     {
+ *       provider: "openai",
+ *       virtual_key: "open-ai-key-1234",
+ *       model: "text-davinci-003",
+ *       max_tokens: 2000,
+ *     },
+ *   ],
+ * });
+ *
+ * // Stream the output of the model and process it
+ * const res = await model.stream(
+ *   "Question: Write a story about a king\nAnswer:"
+ * );
+ * for await (const i of res) {
+ *   process.stdout.write(i);
+ * }
+ * ```
+ */
 class Portkey extends base_js_1.BaseLLM {
     constructor(init) {
         super(init ?? {});

package/dist/llms/portkey.d.ts

@@ -19,6 +19,30 @@ export declare class PortkeySession {
  * @returns
  */
 export declare function getPortkeySession(options?: PortkeyOptions): PortkeySession;
+/**
+ * @example
+ * ```typescript
+ * const model = new Portkey({
+ *   mode: "single",
+ *   llms: [
+ *     {
+ *       provider: "openai",
+ *       virtual_key: "open-ai-key-1234",
+ *       model: "text-davinci-003",
+ *       max_tokens: 2000,
+ *     },
+ *   ],
+ * });
+ *
+ * // Stream the output of the model and process it
+ * const res = await model.stream(
+ *   "Question: Write a story about a king\nAnswer:"
+ * );
+ * for await (const i of res) {
+ *   process.stdout.write(i);
+ * }
+ * ```
+ */
 export declare class Portkey extends BaseLLM {
     apiKey?: string;
     baseURL?: string;

package/dist/llms/portkey.js

@@ -43,6 +43,30 @@ export function getPortkeySession(options = {}) {
     }
     return session;
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new Portkey({
+ *   mode: "single",
+ *   llms: [
+ *     {
+ *       provider: "openai",
+ *       virtual_key: "open-ai-key-1234",
+ *       model: "text-davinci-003",
+ *       max_tokens: 2000,
+ *     },
+ *   ],
+ * });
+ *
+ * // Stream the output of the model and process it
+ * const res = await model.stream(
+ *   "Question: Write a story about a king\nAnswer:"
+ * );
+ * for await (const i of res) {
+ *   process.stdout.write(i);
+ * }
+ * ```
+ */
 export class Portkey extends BaseLLM {
     constructor(init) {
         super(init ?? {});

package/dist/llms/replicate.cjs

@@ -8,6 +8,17 @@ const base_js_1 = require("./base.cjs");
  * It handles the API key and model details, makes the actual API calls,
  * and converts the API response into a format usable by the rest of the
  * LangChain framework.
+ * @example
+ * ```typescript
+ * const model = new Replicate({
+ *   model: "replicate/flan-t5-xl:3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 class Replicate extends base_js_1.LLM {
     static lc_name() {

package/dist/llms/replicate.d.ts

@@ -18,6 +18,17 @@ export interface ReplicateInput {
  * It handles the API key and model details, makes the actual API calls,
  * and converts the API response into a format usable by the rest of the
  * LangChain framework.
+ * @example
+ * ```typescript
+ * const model = new Replicate({
+ *   model: "replicate/flan-t5-xl:3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class Replicate extends LLM implements ReplicateInput {
     static lc_name(): string;

package/dist/llms/replicate.js

@@ -5,6 +5,17 @@ import { LLM } from "./base.js";
  * It handles the API key and model details, makes the actual API calls,
  * and converts the API response into a format usable by the rest of the
  * LangChain framework.
+ * @example
+ * ```typescript
+ * const model = new Replicate({
+ *   model: "replicate/flan-t5-xl:3ae0799123a1fe11f8c89fd99632f843fc5f7a761630160521c4253149754523",
+ * });
+ *
+ * const res = await model.call(
+ *   "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class Replicate extends LLM {
     static lc_name() {

package/dist/load/import_constants.cjs

@@ -67,6 +67,7 @@ exports.optionalImportEntrypoints = [
     "langchain/vectorstores/typeorm",
     "langchain/vectorstores/myscale",
     "langchain/vectorstores/redis",
+    "langchain/vectorstores/rockset",
     "langchain/vectorstores/typesense",
     "langchain/vectorstores/singlestore",
     "langchain/vectorstores/tigris",
@@ -136,6 +137,7 @@ exports.optionalImportEntrypoints = [
     "langchain/cache/momento",
     "langchain/cache/redis",
     "langchain/cache/ioredis",
+    "langchain/cache/file_system",
     "langchain/cache/upstash_redis",
     "langchain/stores/doc/gcs",
     "langchain/stores/file/node",

package/dist/load/import_constants.js

@@ -64,6 +64,7 @@ export const optionalImportEntrypoints = [
     "langchain/vectorstores/typeorm",
     "langchain/vectorstores/myscale",
     "langchain/vectorstores/redis",
+    "langchain/vectorstores/rockset",
     "langchain/vectorstores/typesense",
     "langchain/vectorstores/singlestore",
     "langchain/vectorstores/tigris",
@@ -133,6 +134,7 @@ export const optionalImportEntrypoints = [
     "langchain/cache/momento",
     "langchain/cache/redis",
     "langchain/cache/ioredis",
+    "langchain/cache/file_system",
     "langchain/cache/upstash_redis",
     "langchain/stores/doc/gcs",
     "langchain/stores/file/node",

package/dist/memory/buffer_memory.cjs

@@ -14,6 +14,30 @@ const chat_memory_js_1 = require("./chat_memory.cjs");
  * two different chains. If you deploy your LangChain app on a serverless
  * environment, do not store memory instances in a variable, as your
  * hosting provider may reset it by the next time the function is called.
+ * @example
+ * ```typescript
+ * // Initialize the memory to store chat history and set up the language model with a specific temperature.
+ * const memory = new BufferMemory({ memoryKey: "chat_history" });
+ * const model = new ChatOpenAI({ temperature: 0.9 });
+ *
+ * // Create a prompt template for a friendly conversation between a human and an AI.
+ * const prompt =
+ *   PromptTemplate.fromTemplate(`The following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.
+ *
+ * Current conversation:
+ * {chat_history}
+ * Human: {input}
+ * AI:`);
+ *
+ * // Set up the chain with the language model, prompt, and memory.
+ * const chain = new LLMChain({ llm: model, prompt, memory });
+ *
+ * // Example usage of the chain to continue the conversation.
+ * // The `call` method sends the input to the model and returns the AI's response.
+ * const res = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res });
+ *
+ * ```
  */
 class BufferMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {

package/dist/memory/buffer_memory.d.ts

@@ -19,6 +19,30 @@ export interface BufferMemoryInput extends BaseChatMemoryInput {
  * two different chains. If you deploy your LangChain app on a serverless
  * environment, do not store memory instances in a variable, as your
  * hosting provider may reset it by the next time the function is called.
+ * @example
+ * ```typescript
+ * // Initialize the memory to store chat history and set up the language model with a specific temperature.
+ * const memory = new BufferMemory({ memoryKey: "chat_history" });
+ * const model = new ChatOpenAI({ temperature: 0.9 });
+ *
+ * // Create a prompt template for a friendly conversation between a human and an AI.
+ * const prompt =
+ *   PromptTemplate.fromTemplate(`The following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.
+ *
+ * Current conversation:
+ * {chat_history}
+ * Human: {input}
+ * AI:`);
+ *
+ * // Set up the chain with the language model, prompt, and memory.
+ * const chain = new LLMChain({ llm: model, prompt, memory });
+ *
+ * // Example usage of the chain to continue the conversation.
+ * // The `call` method sends the input to the model and returns the AI's response.
+ * const res = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res });
+ *
+ * ```
  */
 export declare class BufferMemory extends BaseChatMemory implements BufferMemoryInput {
     humanPrefix: string;

package/dist/memory/buffer_memory.js

@@ -11,6 +11,30 @@ import { BaseChatMemory } from "./chat_memory.js";
  * two different chains. If you deploy your LangChain app on a serverless
  * environment, do not store memory instances in a variable, as your
  * hosting provider may reset it by the next time the function is called.
+ * @example
+ * ```typescript
+ * // Initialize the memory to store chat history and set up the language model with a specific temperature.
+ * const memory = new BufferMemory({ memoryKey: "chat_history" });
+ * const model = new ChatOpenAI({ temperature: 0.9 });
+ *
+ * // Create a prompt template for a friendly conversation between a human and an AI.
+ * const prompt =
+ *   PromptTemplate.fromTemplate(`The following is a friendly conversation between a human and an AI. The AI is talkative and provides lots of specific details from its context. If the AI does not know the answer to a question, it truthfully says it does not know.
+ *
+ * Current conversation:
+ * {chat_history}
+ * Human: {input}
+ * AI:`);
+ *
+ * // Set up the chain with the language model, prompt, and memory.
+ * const chain = new LLMChain({ llm: model, prompt, memory });
+ *
+ * // Example usage of the chain to continue the conversation.
+ * // The `call` method sends the input to the model and returns the AI's response.
+ * const res = await chain.call({ input: "Hi! I'm Jim." });
+ * console.log({ res });
+ *
+ * ```
  */
 export class BufferMemory extends BaseChatMemory {
     constructor(fields) {

package/dist/memory/buffer_token_memory.cjs

@@ -7,6 +7,21 @@ const chat_memory_js_1 = require("./chat_memory.cjs");
  * Class that represents a conversation chat memory with a token buffer.
  * It extends the `BaseChatMemory` class and implements the
  * `ConversationTokenBufferMemoryInput` interface.
+ * @example
+ * ```typescript
+ * const memory = new ConversationTokenBufferMemory({
+ *   llm: new ChatOpenAI({}),
+ *   maxTokenLimit: 10,
+ * });
+ *
+ * // Save conversation context
+ * await memory.saveContext({ input: "hi" }, { output: "whats up" });
+ * await memory.saveContext({ input: "not much you" }, { output: "not much" });
+ *
+ * // Load memory variables
+ * const result = await memory.loadMemoryVariables({});
+ * console.log(result);
+ * ```
  */
 class ConversationTokenBufferMemory extends chat_memory_js_1.BaseChatMemory {
     constructor(fields) {

package/dist/memory/buffer_token_memory.d.ts

@@ -15,6 +15,21 @@ export interface ConversationTokenBufferMemoryInput extends BaseChatMemoryInput
  * Class that represents a conversation chat memory with a token buffer.
  * It extends the `BaseChatMemory` class and implements the
  * `ConversationTokenBufferMemoryInput` interface.
+ * @example
+ * ```typescript
+ * const memory = new ConversationTokenBufferMemory({
+ *   llm: new ChatOpenAI({}),
+ *   maxTokenLimit: 10,
+ * });
+ *
+ * // Save conversation context
+ * await memory.saveContext({ input: "hi" }, { output: "whats up" });
+ * await memory.saveContext({ input: "not much you" }, { output: "not much" });
+ *
+ * // Load memory variables
+ * const result = await memory.loadMemoryVariables({});
+ * console.log(result);
+ * ```
  */
 export declare class ConversationTokenBufferMemory extends BaseChatMemory implements ConversationTokenBufferMemoryInput {
     humanPrefix: string;