langchain 0.0.57 → 0.0.59

package/cache/redis.cjs

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

package/cache/redis.d.ts

@@ -0,0 +1 @@
+export * from '../dist/cache/redis.js'

package/cache/redis.js

@@ -0,0 +1 @@
+export * from '../dist/cache/redis.js'

package/cache.cjs

@@ -1 +1 @@
-module.exports = require('./dist/cache.cjs');
+module.exports = require('./dist/cache/index.cjs');

package/cache.d.ts

@@ -1 +1 @@
-export * from './dist/cache.js'
+export * from './dist/cache/index.js'

package/cache.js

@@ -1 +1 @@
-export * from './dist/cache.js'
+export * from './dist/cache/index.js'

package/dist/agents/chat/index.d.ts

@@ -14,7 +14,7 @@ export type CreatePromptArgs = {
     /** List of input variables the final prompt will expect. */
     inputVariables?: string[];
 };
-type ChatAgentInput = Optional<AgentInput, "outputParser">;
+export type ChatAgentInput = Optional<AgentInput, "outputParser">;
 /**
  * Agent for the MRKL chain.
  * @augments Agent
@@ -39,4 +39,3 @@ export declare class ChatAgent extends Agent {
     static createPrompt(tools: Tool[], args?: CreatePromptArgs): ChatPromptTemplate;
     static fromLLMAndTools(llm: BaseLanguageModel, tools: Tool[], args?: CreatePromptArgs & AgentArgs): ChatAgent;
 }
-export {};

package/dist/agents/executor.d.ts

@@ -4,7 +4,7 @@ import { Tool } from "../tools/base.js";
 import { StoppingMethod } from "./types.js";
 import { SerializedLLMChain } from "../chains/serde.js";
 import { ChainValues } from "../schema/index.js";
-interface AgentExecutorInput extends ChainInputs {
+export interface AgentExecutorInput extends ChainInputs {
     agent: BaseSingleActionAgent | BaseMultiActionAgent;
     tools: Tool[];
     returnIntermediateSteps?: boolean;
@@ -31,4 +31,3 @@ export declare class AgentExecutor extends BaseChain {
     _chainType(): "agent_executor";
     serialize(): SerializedLLMChain;
 }
-export {};

package/dist/agents/index.cjs

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentActionOutputParser = exports.ZeroShotAgentOutputParser = exports.ZeroShotAgent = exports.initializeAgentExecutorWithOptions = exports.initializeAgentExecutor = exports.AgentExecutor = exports.ChatConversationalAgentOutputParser = exports.ChatConversationalAgent = exports.ChatAgentOutputParser = exports.ChatAgent = exports.createVectorStoreAgent = exports.createSqlAgent = exports.createOpenApiAgent = exports.createJsonAgent = exports.ZapierToolKit = exports.VectorStoreToolkit = exports.VectorStoreRouterToolkit = exports.SqlToolkit = exports.RequestsToolkit = exports.OpenApiToolkit = exports.JsonToolkit = exports.LLMSingleActionAgent = exports.BaseSingleActionAgent = exports.Agent = exports.Tool = void 0;
-var base_js_1 = require("../tools/base.cjs");
-Object.defineProperty(exports, "Tool", { enumerable: true, get: function () { return base_js_1.Tool; } });
+exports.AgentActionOutputParser = exports.ZeroShotAgentOutputParser = exports.ZeroShotAgent = exports.initializeAgentExecutorWithOptions = exports.initializeAgentExecutor = exports.AgentExecutor = exports.ChatConversationalAgentOutputParser = exports.ChatConversationalAgent = exports.ChatAgentOutputParser = exports.ChatAgent = exports.createVectorStoreAgent = exports.createSqlAgent = exports.createOpenApiAgent = exports.createJsonAgent = exports.ZapierToolKit = exports.VectorStoreToolkit = exports.VectorStoreRouterToolkit = exports.SqlToolkit = exports.RequestsToolkit = exports.OpenApiToolkit = exports.JsonToolkit = exports.LLMSingleActionAgent = exports.BaseSingleActionAgent = exports.Agent = void 0;
 var agent_js_1 = require("./agent.cjs");
 Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_js_1.Agent; } });
 Object.defineProperty(exports, "BaseSingleActionAgent", { enumerable: true, get: function () { return agent_js_1.BaseSingleActionAgent; } });

package/dist/agents/index.d.ts

@@ -1,12 +1,11 @@
-export { Tool } from "../tools/base.js";
-export { Agent, BaseSingleActionAgent, LLMSingleActionAgent } from "./agent.js";
+export { Agent, AgentArgs, BaseSingleActionAgent, LLMSingleActionAgent, LLMSingleActionAgentInput, } from "./agent.js";
 export { JsonToolkit, OpenApiToolkit, RequestsToolkit, SqlToolkit, VectorStoreInfo, VectorStoreRouterToolkit, VectorStoreToolkit, ZapierToolKit, createJsonAgent, createOpenApiAgent, createSqlAgent, createVectorStoreAgent, } from "./agent_toolkits/index.js";
-export { ChatAgent } from "./chat/index.js";
+export { ChatAgent, ChatAgentInput } from "./chat/index.js";
 export { ChatAgentOutputParser } from "./chat/outputParser.js";
 export { ChatConversationalAgent, ChatConversationalAgentInput, } from "./chat_convo/index.js";
 export { ChatConversationalAgentOutputParser } from "./chat_convo/outputParser.js";
-export { AgentExecutor } from "./executor.js";
-export { initializeAgentExecutor, initializeAgentExecutorWithOptions, } from "./initialize.js";
-export { ZeroShotAgent } from "./mrkl/index.js";
+export { AgentExecutor, AgentExecutorInput } from "./executor.js";
+export { initializeAgentExecutor, initializeAgentExecutorWithOptions, InitializeAgentExecutorOptions, } from "./initialize.js";
+export { ZeroShotAgent, ZeroShotAgentInput } from "./mrkl/index.js";
 export { ZeroShotAgentOutputParser } from "./mrkl/outputParser.js";
 export { AgentActionOutputParser, AgentInput, SerializedAgent, SerializedAgentT, SerializedZeroShotAgent, StoppingMethod, } from "./types.js";

package/dist/agents/index.js

@@ -1,5 +1,4 @@
-export { Tool } from "../tools/base.js";
-export { Agent, BaseSingleActionAgent, LLMSingleActionAgent } from "./agent.js";
+export { Agent, BaseSingleActionAgent, LLMSingleActionAgent, } from "./agent.js";
 export { JsonToolkit, OpenApiToolkit, RequestsToolkit, SqlToolkit, VectorStoreRouterToolkit, VectorStoreToolkit, ZapierToolKit, createJsonAgent, createOpenApiAgent, createSqlAgent, createVectorStoreAgent, } from "./agent_toolkits/index.js";
 export { ChatAgent } from "./chat/index.js";
 export { ChatAgentOutputParser } from "./chat/outputParser.js";

package/dist/agents/initialize.cjs

@@ -40,6 +40,13 @@ const initializeAgentExecutor = async (tools, llm, _agentType, _verbose, _callba
     }
 };
 exports.initializeAgentExecutor = initializeAgentExecutor;
+/**
+ * Initialize an agent executor with options
+ * @param tools Array of tools to use in the agent
+ * @param llm LLM or ChatModel to use in the agent
+ * @param options Options for the agent, including agentType, agentArgs, and other options for AgentExecutor.fromAgentAndTools
+ * @returns AgentExecutor
+ */
 const initializeAgentExecutorWithOptions = async (tools, llm, options = {
     agentType: llm._modelType() === "base_chat_model"
         ? "chat-zero-shot-react-description"

package/dist/agents/initialize.d.ts

@@ -7,7 +7,7 @@ import { AgentExecutor } from "./executor.js";
 import { ZeroShotAgent } from "./mrkl/index.js";
 type AgentType = "zero-shot-react-description" | "chat-zero-shot-react-description" | "chat-conversational-react-description";
 export declare const initializeAgentExecutor: (tools: Tool[], llm: BaseLanguageModel, _agentType?: AgentType, _verbose?: boolean, _callbackManager?: CallbackManager) => Promise<AgentExecutor>;
-type AgentExecutorOptions = ({
+export type InitializeAgentExecutorOptions = ({
     agentType: "zero-shot-react-description";
     agentArgs?: Parameters<typeof ZeroShotAgent.fromLLMAndTools>[2];
 } & Omit<Parameters<typeof AgentExecutor.fromAgentAndTools>[0], "agent" | "tools" | "memory">) | ({
@@ -17,5 +17,12 @@ type AgentExecutorOptions = ({
     agentType: "chat-conversational-react-description";
     agentArgs?: Parameters<typeof ChatConversationalAgent.fromLLMAndTools>[2];
 } & Omit<Parameters<typeof AgentExecutor.fromAgentAndTools>[0], "agent" | "tools">);
-export declare const initializeAgentExecutorWithOptions: (tools: Tool[], llm: BaseLanguageModel, options?: AgentExecutorOptions) => Promise<AgentExecutor>;
+/**
+ * Initialize an agent executor with options
+ * @param tools Array of tools to use in the agent
+ * @param llm LLM or ChatModel to use in the agent
+ * @param options Options for the agent, including agentType, agentArgs, and other options for AgentExecutor.fromAgentAndTools
+ * @returns AgentExecutor
+ */
+export declare const initializeAgentExecutorWithOptions: (tools: Tool[], llm: BaseLanguageModel, options?: InitializeAgentExecutorOptions) => Promise<AgentExecutor>;
 export {};

package/dist/agents/initialize.js

@@ -36,6 +36,13 @@ export const initializeAgentExecutor = async (tools, llm, _agentType, _verbose,
             throw new Error("Unknown agent type");
     }
 };
+/**
+ * Initialize an agent executor with options
+ * @param tools Array of tools to use in the agent
+ * @param llm LLM or ChatModel to use in the agent
+ * @param options Options for the agent, including agentType, agentArgs, and other options for AgentExecutor.fromAgentAndTools
+ * @returns AgentExecutor
+ */
 export const initializeAgentExecutorWithOptions = async (tools, llm, options = {
     agentType: llm._modelType() === "base_chat_model"
         ? "chat-zero-shot-react-description"

package/dist/cache/base.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCacheKey = void 0;
+const object_hash_1 = __importDefault(require("object-hash"));
+/**
+ * This cache key should be consistent across all versions of langchain.
+ * It is currently NOT consistent across versions of langchain.
+ *
+ * A huge benefit of having a remote cache (like redis) is that you can
+ * access the cache from different processes/machines. The allows you to
+ * seperate concerns and scale horizontally.
+ *
+ * TODO: Make cache key consistent across versions of langchain.
+ */
+const getCacheKey = (...strings) => (0, object_hash_1.default)(strings.join("_"));
+exports.getCacheKey = getCacheKey;

package/dist/cache/base.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This cache key should be consistent across all versions of langchain.
+ * It is currently NOT consistent across versions of langchain.
+ *
+ * A huge benefit of having a remote cache (like redis) is that you can
+ * access the cache from different processes/machines. The allows you to
+ * seperate concerns and scale horizontally.
+ *
+ * TODO: Make cache key consistent across versions of langchain.
+ */
+export declare const getCacheKey: (...strings: string[]) => string;

package/dist/cache/base.js

@@ -0,0 +1,12 @@
+import hash from "object-hash";
+/**
+ * This cache key should be consistent across all versions of langchain.
+ * It is currently NOT consistent across versions of langchain.
+ *
+ * A huge benefit of having a remote cache (like redis) is that you can
+ * access the cache from different processes/machines. The allows you to
+ * seperate concerns and scale horizontally.
+ *
+ * TODO: Make cache key consistent across versions of langchain.
+ */
+export const getCacheKey = (...strings) => hash(strings.join("_"));

package/dist/cache/index.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryCache = void 0;
+const base_js_1 = require("./base.cjs");
+const index_js_1 = require("../schema/index.cjs");
+const GLOBAL_MAP = new Map();
+class InMemoryCache extends index_js_1.BaseCache {
+    constructor(map) {
+        super();
+        Object.defineProperty(this, "cache", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.cache = map ?? new Map();
+    }
+    lookup(prompt, llmKey) {
+        return Promise.resolve(this.cache.get((0, base_js_1.getCacheKey)(prompt, llmKey)) ?? null);
+    }
+    async update(prompt, llmKey, value) {
+        this.cache.set((0, base_js_1.getCacheKey)(prompt, llmKey), value);
+    }
+    static global() {
+        return new InMemoryCache(GLOBAL_MAP);
+    }
+}
+exports.InMemoryCache = InMemoryCache;

package/dist/cache/index.d.ts

@@ -0,0 +1,8 @@
+import { Generation, BaseCache } from "../schema/index.js";
+export declare class InMemoryCache<T = Generation[]> extends BaseCache<T> {
+    private cache;
+    constructor(map?: Map<string, T>);
+    lookup(prompt: string, llmKey: string): Promise<T | null>;
+    update(prompt: string, llmKey: string, value: T): Promise<void>;
+    static global(): InMemoryCache;
+}

package/dist/cache/index.js

@@ -0,0 +1,24 @@
+import { getCacheKey } from "./base.js";
+import { BaseCache } from "../schema/index.js";
+const GLOBAL_MAP = new Map();
+export class InMemoryCache extends BaseCache {
+    constructor(map) {
+        super();
+        Object.defineProperty(this, "cache", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.cache = map ?? new Map();
+    }
+    lookup(prompt, llmKey) {
+        return Promise.resolve(this.cache.get(getCacheKey(prompt, llmKey)) ?? null);
+    }
+    async update(prompt, llmKey, value) {
+        this.cache.set(getCacheKey(prompt, llmKey), value);
+    }
+    static global() {
+        return new InMemoryCache(GLOBAL_MAP);
+    }
+}

package/dist/cache/redis.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisCache = void 0;
+const index_js_1 = require("../schema/index.cjs");
+const base_js_1 = require("./base.cjs");
+class RedisCache extends index_js_1.BaseCache {
+    constructor(redisClient) {
+        super();
+        Object.defineProperty(this, "redisClient", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redisClient = redisClient;
+    }
+    async lookup(prompt, llmKey) {
+        let idx = 0;
+        let key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
+        let value = await this.redisClient.get(key);
+        const generations = [];
+        while (value) {
+            if (!value) {
+                break;
+            }
+            generations.push({ text: value });
+            idx += 1;
+            key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(idx));
+            value = await this.redisClient.get(key);
+        }
+        return generations.length > 0 ? generations : null;
+    }
+    async update(prompt, llmKey, value) {
+        for (let i = 0; i < value.length; i += 1) {
+            const key = (0, base_js_1.getCacheKey)(prompt, llmKey, String(i));
+            await this.redisClient.set(key, value[i].text);
+        }
+    }
+}
+exports.RedisCache = RedisCache;

package/dist/cache/redis.d.ts

@@ -0,0 +1,8 @@
+import type { RedisClientType } from "redis";
+import { BaseCache, Generation } from "../schema/index.js";
+export declare class RedisCache extends BaseCache {
+    private redisClient;
+    constructor(redisClient: RedisClientType);
+    lookup(prompt: string, llmKey: string): Promise<Generation[] | null>;
+    update(prompt: string, llmKey: string, value: Generation[]): Promise<void>;
+}

package/dist/cache/redis.js

@@ -0,0 +1,36 @@
+import { BaseCache } from "../schema/index.js";
+import { getCacheKey } from "./base.js";
+export class RedisCache extends BaseCache {
+    constructor(redisClient) {
+        super();
+        Object.defineProperty(this, "redisClient", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redisClient = redisClient;
+    }
+    async lookup(prompt, llmKey) {
+        let idx = 0;
+        let key = getCacheKey(prompt, llmKey, String(idx));
+        let value = await this.redisClient.get(key);
+        const generations = [];
+        while (value) {
+            if (!value) {
+                break;
+            }
+            generations.push({ text: value });
+            idx += 1;
+            key = getCacheKey(prompt, llmKey, String(idx));
+            value = await this.redisClient.get(key);
+        }
+        return generations.length > 0 ? generations : null;
+    }
+    async update(prompt, llmKey, value) {
+        for (let i = 0; i < value.length; i += 1) {
+            const key = getCacheKey(prompt, llmKey, String(i));
+            await this.redisClient.set(key, value[i].text);
+        }
+    }
+}

package/dist/chat_models/anthropic.cjs

@@ -29,8 +29,6 @@ const DEFAULT_STOP_SEQUENCES = [sdk_1.HUMAN_PROMPT];
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
  *
- * @augments BaseLLM
- * @augments AnthropicInput
  */
 class ChatAnthropic extends base_js_1.BaseChatModel {
     constructor(fields) {
@@ -137,6 +135,7 @@ class ChatAnthropic extends base_js_1.BaseChatModel {
             ...this.invocationKwargs,
         };
     }
+    /** @ignore */
     _identifyingParams() {
         return {
             model_name: this.modelName,
@@ -160,21 +159,7 @@ class ChatAnthropic extends base_js_1.BaseChatModel {
         })
             .join("") + sdk_1.AI_PROMPT);
     }
-    /**
-     * Call out to Anthropic's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stopSequences] - Optional list of stop sequences to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { ChatAnthropic } from "langchain/chat_models/openai";
-     * const anthropic = new ChatAnthropic();
-     * const response = await anthropic.generate(new HumanChatMessage(["Tell me a joke."]));
-     * ```
-     */
+    /** @ignore */
     async _generate(messages, stopSequences) {
         if (this.stopSequences && stopSequences) {
             throw new Error(`"stopSequence" parameter found in input and default params`);
@@ -236,6 +221,7 @@ class ChatAnthropic extends base_js_1.BaseChatModel {
     _llmType() {
         return "anthropic";
     }
+    /** @ignore */
     _combineLLMOutput() {
         return [];
     }

package/dist/chat_models/anthropic.d.ts

@@ -1,7 +1,10 @@
 import { CompletionResponse, SamplingParameters } from "@anthropic-ai/sdk";
 import { BaseChatModel, BaseChatModelParams } from "./base.js";
 import { BaseChatMessage, ChatResult } from "../schema/index.js";
-interface ModelParams {
+/**
+ * Input to AnthropicChat class.
+ */
+export interface AnthropicInput {
     /** Amount of randomness injected into the response. Ranges
      * from 0 to 1. Use temp closer to 0 for analytical /
      * multiple choice, and temp closer to 1 for creative
@@ -25,18 +28,12 @@ interface ModelParams {
     /** A maximum number of tokens to generate before stopping. */
     maxTokensToSample: number;
     /** A list of strings upon which to stop generating.
-     * You probably want ["\n\nHuman:"], as that's the cue for
+     * You probably want `["\n\nHuman:"]`, as that's the cue for
      * the next turn in the dialog agent.
      */
     stopSequences?: string[];
     /** Whether to stream the results or not */
     streaming?: boolean;
-}
-/**
- * Input to AnthropicChat class.
- * @augments ModelParams
- */
-interface AnthropicInput extends ModelParams {
     /** Anthropic API key */
     apiKey?: string;
     /** Model name to use */
@@ -60,8 +57,6 @@ type Kwargs = Record<string, any>;
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
  *
- * @augments BaseLLM
- * @augments AnthropicInput
  */
 export declare class ChatAnthropic extends BaseChatModel implements AnthropicInput {
     apiKey?: string;
@@ -82,6 +77,7 @@ export declare class ChatAnthropic extends BaseChatModel implements AnthropicInp
      * Get the parameters used to invoke the model
      */
     invocationParams(): Omit<SamplingParameters, "prompt"> & Kwargs;
+    /** @ignore */
     _identifyingParams(): {
         model: string;
         temperature?: number | undefined;
@@ -110,25 +106,12 @@ export declare class ChatAnthropic extends BaseChatModel implements AnthropicInp
         model_name: string;
     };
     private formatMessagesAsPrompt;
-    /**
-     * Call out to Anthropic's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stopSequences] - Optional list of stop sequences to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { ChatAnthropic } from "langchain/chat_models/openai";
-     * const anthropic = new ChatAnthropic();
-     * const response = await anthropic.generate(new HumanChatMessage(["Tell me a joke."]));
-     * ```
-     */
+    /** @ignore */
     _generate(messages: BaseChatMessage[], stopSequences?: string[]): Promise<ChatResult>;
     /** @ignore */
     completionWithRetry(request: SamplingParameters & Kwargs): Promise<CompletionResponse>;
     _llmType(): string;
+    /** @ignore */
     _combineLLMOutput(): never[];
 }
 export {};

package/dist/chat_models/anthropic.js

@@ -26,8 +26,6 @@ const DEFAULT_STOP_SEQUENCES = [HUMAN_PROMPT];
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
  *
- * @augments BaseLLM
- * @augments AnthropicInput
  */
 export class ChatAnthropic extends BaseChatModel {
     constructor(fields) {
@@ -134,6 +132,7 @@ export class ChatAnthropic extends BaseChatModel {
             ...this.invocationKwargs,
         };
     }
+    /** @ignore */
     _identifyingParams() {
         return {
             model_name: this.modelName,
@@ -157,21 +156,7 @@ export class ChatAnthropic extends BaseChatModel {
         })
             .join("") + AI_PROMPT);
     }
-    /**
-     * Call out to Anthropic's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stopSequences] - Optional list of stop sequences to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { ChatAnthropic } from "langchain/chat_models/openai";
-     * const anthropic = new ChatAnthropic();
-     * const response = await anthropic.generate(new HumanChatMessage(["Tell me a joke."]));
-     * ```
-     */
+    /** @ignore */
     async _generate(messages, stopSequences) {
         if (this.stopSequences && stopSequences) {
             throw new Error(`"stopSequence" parameter found in input and default params`);
@@ -233,6 +218,7 @@ export class ChatAnthropic extends BaseChatModel {
     _llmType() {
         return "anthropic";
     }
+    /** @ignore */
     _combineLLMOutput() {
         return [];
     }

package/dist/chat_models/openai.cjs

@@ -179,6 +179,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
             ...this.modelKwargs,
         };
     }
+    /** @ignore */
     _identifyingParams() {
         return {
             model_name: this.modelName,
@@ -192,21 +193,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
     identifyingParams() {
         return this._identifyingParams();
     }
-    /**
-     * Call out to OpenAI's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stop] - Optional list of stop words to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { OpenAI } from "langchain/llms/openai";
-     * const openai = new OpenAI();
-     * const response = await openai.generate(["Tell me a joke."]);
-     * ```
-     */
+    /** @ignore */
     async _generate(messages, stop) {
         const tokenUsage = {};
         if (this.stop && stop) {
@@ -345,6 +332,7 @@ class ChatOpenAI extends base_js_1.BaseChatModel {
     _llmType() {
         return "openai";
     }
+    /** @ignore */
     _combineLLMOutput(...llmOutputs) {
         return llmOutputs.reduce((acc, llmOutput) => {
             if (llmOutput && llmOutput.tokenUsage) {

package/dist/chat_models/openai.d.ts

@@ -10,7 +10,7 @@ interface TokenUsage {
 interface OpenAILLMOutput {
     tokenUsage: TokenUsage;
 }
-interface ModelParams {
+export interface OpenAIInput {
     /** Sampling temperature to use, between 0 and 2, defaults to 1 */
     temperature: number;
     /** Total probability mass of tokens to consider at each step, between 0 and 1, defaults to 1 */
@@ -30,12 +30,6 @@ interface ModelParams {
      * defaults to the maximum number of tokens allowed by the model.
      */
     maxTokens?: number;
-}
-/**
- * Input to OpenAI class.
- * @augments ModelParams
- */
-interface OpenAIInput extends ModelParams {
     /** Model name to use */
     modelName: string;
     /** Holds any additional parameters that are valid to pass to {@link
@@ -90,6 +84,7 @@ export declare class ChatOpenAI extends BaseChatModel implements OpenAIInput {
      * Get the parameters used to invoke the model
      */
     invocationParams(): Omit<CreateChatCompletionRequest, "messages"> & Kwargs;
+    /** @ignore */
     _identifyingParams(): {
         apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>) | undefined;
         organization?: string | undefined;
@@ -137,21 +132,7 @@ export declare class ChatOpenAI extends BaseChatModel implements OpenAIInput {
         logit_bias?: object | null | undefined;
         model_name: string;
     };
-    /**
-     * Call out to OpenAI's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stop] - Optional list of stop words to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { OpenAI } from "langchain/llms/openai";
-     * const openai = new OpenAI();
-     * const response = await openai.generate(["Tell me a joke."]);
-     * ```
-     */
+    /** @ignore */
     _generate(messages: BaseChatMessage[], stop?: string[]): Promise<ChatResult>;
     getNumTokensFromMessages(messages: BaseChatMessage[]): Promise<{
         totalCount: number;
@@ -160,6 +141,7 @@ export declare class ChatOpenAI extends BaseChatModel implements OpenAIInput {
     /** @ignore */
     completionWithRetry(request: CreateChatCompletionRequest, options?: StreamingAxiosConfiguration): Promise<CreateChatCompletionResponse>;
     _llmType(): string;
+    /** @ignore */
     _combineLLMOutput(...llmOutputs: OpenAILLMOutput[]): OpenAILLMOutput;
 }
 export {};

package/dist/chat_models/openai.js

@@ -173,6 +173,7 @@ export class ChatOpenAI extends BaseChatModel {
             ...this.modelKwargs,
         };
     }
+    /** @ignore */
     _identifyingParams() {
         return {
             model_name: this.modelName,
@@ -186,21 +187,7 @@ export class ChatOpenAI extends BaseChatModel {
     identifyingParams() {
         return this._identifyingParams();
     }
-    /**
-     * Call out to OpenAI's endpoint with k unique prompts
-     *
-     * @param messages - The messages to pass into the model.
-     * @param [stop] - Optional list of stop words to use when generating.
-     *
-     * @returns The full LLM output.
-     *
-     * @example
-     * ```ts
-     * import { OpenAI } from "langchain/llms/openai";
-     * const openai = new OpenAI();
-     * const response = await openai.generate(["Tell me a joke."]);
-     * ```
-     */
+    /** @ignore */
     async _generate(messages, stop) {
         const tokenUsage = {};
         if (this.stop && stop) {
@@ -339,6 +326,7 @@ export class ChatOpenAI extends BaseChatModel {
     _llmType() {
         return "openai";
     }
+    /** @ignore */
     _combineLLMOutput(...llmOutputs) {
         return llmOutputs.reduce((acc, llmOutput) => {
             if (llmOutput && llmOutput.tokenUsage) {