langchain 0.0.192 → 0.0.194

package/dist/experimental/generative_agents/generative_agent_memory.d.ts

@@ -95,6 +95,24 @@ declare class GenerativeAgentMemoryChain extends BaseChain {
  * formatting memories, getting memories until a token limit is reached,
  * loading memory variables, saving the context of a model run to memory,
  * and clearing memory contents.
+ * @example
+ * ```typescript
+ * const createNewMemoryRetriever = async () => {
+ *   const vectorStore = new MemoryVectorStore(new OpenAIEmbeddings());
+ *   const retriever = new TimeWeightedVectorStoreRetriever({
+ *     vectorStore,
+ *     otherScoreKeys: ["importance"],
+ *     k: 15,
+ *   });
+ *   return retriever;
+ * };
+ * const tommiesMemory = new GenerativeAgentMemory(
+ *   llm,
+ *   await createNewMemoryRetriever(),
+ *   { reflectionThreshold: 8 },
+ * );
+ * const summary = await tommiesMemory.getSummary();
+ * ```
  */
 export declare class GenerativeAgentMemory extends BaseMemory {
     llm: BaseLanguageModel;

package/dist/experimental/generative_agents/generative_agent_memory.js

@@ -243,6 +243,24 @@ class GenerativeAgentMemoryChain extends BaseChain {
  * formatting memories, getting memories until a token limit is reached,
  * loading memory variables, saving the context of a model run to memory,
  * and clearing memory contents.
+ * @example
+ * ```typescript
+ * const createNewMemoryRetriever = async () => {
+ *   const vectorStore = new MemoryVectorStore(new OpenAIEmbeddings());
+ *   const retriever = new TimeWeightedVectorStoreRetriever({
+ *     vectorStore,
+ *     otherScoreKeys: ["importance"],
+ *     k: 15,
+ *   });
+ *   return retriever;
+ * };
+ * const tommiesMemory = new GenerativeAgentMemory(
+ *   llm,
+ *   await createNewMemoryRetriever(),
+ *   { reflectionThreshold: 8 },
+ * );
+ * const summary = await tommiesMemory.getSummary();
+ * ```
  */
 export class GenerativeAgentMemory extends BaseMemory {
     constructor(llm, memoryRetriever, config) {

package/dist/llms/base.cjs

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LLM = exports.BaseLLM = void 0;
 const index_js_1 = require("../schema/index.cjs");
-const index_js_2 = require("../base_language/index.cjs");
 const manager_js_1 = require("../callbacks/manager.cjs");
+const index_js_2 = require("../base_language/index.cjs");
 const base_js_1 = require("../memory/base.cjs");
 /**
  * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
@@ -54,6 +54,7 @@ class BaseLLM extends index_js_2.BaseLanguageModel {
             const extra = {
                 options: callOptions,
                 invocation_params: this?.invocationParams(callOptions),
+                batch_size: 1,
             };
             const runManagers = await callbackManager_?.handleLLMStart(this.toJSON(), [prompt.toString()], undefined, undefined, extra, undefined, undefined, runnableConfig.runName);
             let generation = new index_js_1.GenerationChunk({
@@ -128,6 +129,7 @@ class BaseLLM extends index_js_2.BaseLanguageModel {
         const extra = {
             options: parsedOptions,
             invocation_params: this?.invocationParams(parsedOptions),
+            batch_size: prompts.length,
         };
         const runManagers = await callbackManager_?.handleLLMStart(this.toJSON(), prompts, undefined, undefined, extra, undefined, undefined, handledOptions?.runName);
         let output;

package/dist/llms/base.d.ts

@@ -1,6 +1,6 @@
 import { BaseMessage, BasePromptValue, GenerationChunk, LLMResult } from "../schema/index.js";
-import { BaseLanguageModel, BaseLanguageModelCallOptions, BaseLanguageModelInput, BaseLanguageModelParams } from "../base_language/index.js";
 import { BaseCallbackConfig, CallbackManagerForLLMRun, Callbacks } from "../callbacks/manager.js";
+import { BaseLanguageModel, BaseLanguageModelCallOptions, BaseLanguageModelInput, BaseLanguageModelParams } from "../base_language/index.js";
 import { RunnableConfig } from "../schema/runnable/config.js";
 export type SerializedLLM = {
     _model: string;

package/dist/llms/base.js

@@ -1,6 +1,6 @@
 import { AIMessage, GenerationChunk, RUN_KEY, } from "../schema/index.js";
-import { BaseLanguageModel, } from "../base_language/index.js";
 import { CallbackManager, } from "../callbacks/manager.js";
+import { BaseLanguageModel, } from "../base_language/index.js";
 import { getBufferString } from "../memory/base.js";
 /**
  * LLM Wrapper. Provides an {@link call} (an {@link generate}) function that takes in a prompt (or prompts) and returns a string.
@@ -51,6 +51,7 @@ export class BaseLLM extends BaseLanguageModel {
             const extra = {
                 options: callOptions,
                 invocation_params: this?.invocationParams(callOptions),
+                batch_size: 1,
             };
             const runManagers = await callbackManager_?.handleLLMStart(this.toJSON(), [prompt.toString()], undefined, undefined, extra, undefined, undefined, runnableConfig.runName);
             let generation = new GenerationChunk({
@@ -125,6 +126,7 @@ export class BaseLLM extends BaseLanguageModel {
         const extra = {
             options: parsedOptions,
             invocation_params: this?.invocationParams(parsedOptions),
+            batch_size: prompts.length,
         };
         const runManagers = await callbackManager_?.handleLLMStart(this.toJSON(), prompts, undefined, undefined, extra, undefined, undefined, handledOptions?.runName);
         let output;

package/dist/llms/cohere.cjs

@@ -6,6 +6,19 @@ const base_js_1 = require("./base.cjs");
 /**
  * Class representing a Cohere Large Language Model (LLM). It interacts
  * with the Cohere API to generate text completions.
+ * @example
+ * ```typescript
+ * const model = new Cohere({
+ *   temperature: 0.7,
+ *   maxTokens: 20,
+ *   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 Cohere extends base_js_1.LLM {
     static lc_name() {

package/dist/llms/cohere.d.ts

@@ -16,6 +16,19 @@ export interface CohereInput extends BaseLLMParams {
 /**
  * Class representing a Cohere Large Language Model (LLM). It interacts
  * with the Cohere API to generate text completions.
+ * @example
+ * ```typescript
+ * const model = new Cohere({
+ *   temperature: 0.7,
+ *   maxTokens: 20,
+ *   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 Cohere extends LLM implements CohereInput {
     static lc_name(): string;

package/dist/llms/cohere.js

@@ -3,6 +3,19 @@ import { LLM } from "./base.js";
 /**
  * Class representing a Cohere Large Language Model (LLM). It interacts
  * with the Cohere API to generate text completions.
+ * @example
+ * ```typescript
+ * const model = new Cohere({
+ *   temperature: 0.7,
+ *   maxTokens: 20,
+ *   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 Cohere extends LLM {
     static lc_name() {

package/dist/llms/googlevertexai/index.cjs

@@ -17,6 +17,18 @@ const googlevertexai_gauth_js_1 = require("../../util/googlevertexai-gauth.cjs")
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @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/index.d.ts

@@ -19,6 +19,18 @@ export interface GoogleVertexAITextInput extends GoogleVertexAIBaseLLMInput<Goog
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @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<GoogleAuthOptions> {
     static lc_name(): string;

package/dist/llms/googlevertexai/index.js

@@ -14,6 +14,18 @@ import { GAuthClient } from "../../util/googlevertexai-gauth.js";
  * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
  *   path of a credentials file for a service account permitted to the
  *   Google Cloud project using Vertex AI.
+ * @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/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 ?? {});