langchain 0.0.131 → 0.0.132

package/dist/chat_models/baiduwenxin.js

@@ -1,12 +1,22 @@
 import { BaseChatModel } from "./base.js";
 import { AIMessage, ChatMessage, } from "../schema/index.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Function that extracts the custom role of a generic chat message.
+ * @param message Chat message from which to extract the custom role.
+ * @returns The custom role of the chat message.
+ */
 function extractGenericMessageCustomRole(message) {
     if (message.role !== "assistant" && message.role !== "user") {
         console.warn(`Unknown message role: ${message.role}`);
     }
     return message.role;
 }
+/**
+ * Function that converts a base message to a Wenxin message role.
+ * @param message Base message to convert.
+ * @returns The Wenxin message role.
+ */
 function messageToWenxinRole(message) {
     const type = message._getType();
     switch (type) {
@@ -155,6 +165,12 @@ export class ChatBaiduWenxin extends BaseChatModel {
             throw new Error(`Invalid model name: ${this.modelName}`);
         }
     }
+    /**
+     * Method that retrieves the access token for making requests to the Baidu
+     * API.
+     * @param options Optional parsed call options.
+     * @returns The access token for making requests to the Baidu API.
+     */
     async getAccessToken(options) {
         const url = `https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=${this.baiduApiKey}&client_secret=${this.baiduSecretKey}`;
         const response = await fetch(url, {

package/dist/chat_models/base.cjs

@@ -4,6 +4,11 @@ exports.SimpleChatModel = exports.BaseChatModel = exports.createChatMessageChunk
 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");
+/**
+ * Creates a transform stream for encoding chat message chunks.
+ * @deprecated Use {@link BytesOutputParser} instead
+ * @returns A TransformStream instance that encodes chat message chunks.
+ */
 function createChatMessageChunkEncoderStream() {
     const textEncoder = new TextEncoder();
     return new TransformStream({
@@ -13,6 +18,10 @@ function createChatMessageChunkEncoderStream() {
     });
 }
 exports.createChatMessageChunkEncoderStream = createChatMessageChunkEncoderStream;
+/**
+ * Base class for chat models. It extends the BaseLanguageModel class and
+ * provides methods for generating chat based on input messages.
+ */
 class BaseChatModel extends index_js_2.BaseLanguageModel {
     constructor(fields) {
         super(fields);
@@ -30,6 +39,12 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
         }
         return [runnableConfig, callOptions];
     }
+    /**
+     * Invokes the chat model with a single input.
+     * @param input The input for the language model.
+     * @param options The call options.
+     * @returns A Promise that resolves to a BaseMessageChunk.
+     */
     async invoke(input, options) {
         const promptValue = BaseChatModel._convertInputToPromptValue(input);
         const result = await this.generatePrompt([promptValue], options, options?.callbacks);
@@ -79,6 +94,13 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
             })));
         }
     }
+    /**
+     * Generates chat based on the input messages.
+     * @param messages An array of arrays of BaseMessage instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     async generate(messages, options, callbacks) {
         // parse call options
         let parsedOptions;
@@ -142,22 +164,57 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
     _modelType() {
         return "base_chat_model";
     }
+    /**
+     * Generates a prompt based on the input prompt values.
+     * @param promptValues An array of BasePromptValue instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     async generatePrompt(promptValues, options, callbacks) {
         const promptMessages = promptValues.map((promptValue) => promptValue.toChatMessages());
         return this.generate(promptMessages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async call(messages, options, callbacks) {
         const result = await this.generate([messages], options, callbacks);
         const generations = result.generations;
         return generations[0][0].message;
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async callPrompt(promptValue, options, callbacks) {
         const promptMessages = promptValue.toChatMessages();
         return this.call(promptMessages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async predictMessages(messages, options, callbacks) {
         return this.call(messages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a string.
+     */
     async predict(text, options, callbacks) {
         const message = new index_js_1.HumanMessage(text);
         const result = await this.call([message], options, callbacks);
@@ -165,6 +222,10 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
     }
 }
 exports.BaseChatModel = BaseChatModel;
+/**
+ * An abstract class that extends BaseChatModel and provides a simple
+ * implementation of _generate.
+ */
 class SimpleChatModel extends BaseChatModel {
     async _generate(messages, options, runManager) {
         const text = await this._call(messages, options, runManager);

package/dist/chat_models/base.d.ts

@@ -2,26 +2,60 @@ import { BaseMessage, BasePromptValue, ChatResult, BaseMessageChunk, LLMResult,
 import { BaseLanguageModel, BaseLanguageModelCallOptions, BaseLanguageModelInput, BaseLanguageModelParams } from "../base_language/index.js";
 import { CallbackManagerForLLMRun, Callbacks } from "../callbacks/manager.js";
 import { RunnableConfig } from "../schema/runnable.js";
+/**
+ * Represents a serialized chat model.
+ */
 export type SerializedChatModel = {
     _model: string;
     _type: string;
 } & Record<string, any>;
+/**
+ * Represents a serialized large language model.
+ */
 export type SerializedLLM = {
     _model: string;
     _type: string;
 } & Record<string, any>;
+/**
+ * Represents the parameters for a base chat model.
+ */
 export type BaseChatModelParams = BaseLanguageModelParams;
+/**
+ * Represents the call options for a base chat model.
+ */
 export type BaseChatModelCallOptions = BaseLanguageModelCallOptions;
+/**
+ * Creates a transform stream for encoding chat message chunks.
+ * @deprecated Use {@link BytesOutputParser} instead
+ * @returns A TransformStream instance that encodes chat message chunks.
+ */
 export declare function createChatMessageChunkEncoderStream(): TransformStream<BaseMessageChunk, any>;
+/**
+ * Base class for chat models. It extends the BaseLanguageModel class and
+ * provides methods for generating chat based on input messages.
+ */
 export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCallOptions = BaseChatModelCallOptions> extends BaseLanguageModel<BaseMessageChunk, CallOptions> {
     ParsedCallOptions: Omit<CallOptions, keyof RunnableConfig & "timeout">;
     lc_namespace: string[];
     constructor(fields: BaseChatModelParams);
     abstract _combineLLMOutput?(...llmOutputs: LLMResult["llmOutput"][]): LLMResult["llmOutput"];
     protected _separateRunnableConfigFromCallOptions(options?: Partial<CallOptions>): [RunnableConfig, this["ParsedCallOptions"]];
+    /**
+     * Invokes the chat model with a single input.
+     * @param input The input for the language model.
+     * @param options The call options.
+     * @returns A Promise that resolves to a BaseMessageChunk.
+     */
     invoke(input: BaseLanguageModelInput, options?: CallOptions): Promise<BaseMessageChunk>;
     _streamResponseChunks(_messages: BaseMessage[], _options: this["ParsedCallOptions"], _runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
     _streamIterator(input: BaseLanguageModelInput, options?: CallOptions): AsyncGenerator<BaseMessageChunk>;
+    /**
+     * Generates chat based on the input messages.
+     * @param messages An array of arrays of BaseMessage instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     generate(messages: BaseMessage[][], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
     /**
      * Get the parameters used to invoke the model
@@ -29,13 +63,52 @@ export declare abstract class BaseChatModel<CallOptions extends BaseChatModelCal
     invocationParams(_options?: this["ParsedCallOptions"]): any;
     _modelType(): string;
     abstract _llmType(): string;
+    /**
+     * Generates a prompt based on the input prompt values.
+     * @param promptValues An array of BasePromptValue instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     generatePrompt(promptValues: BasePromptValue[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<LLMResult>;
     abstract _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     call(messages: BaseMessage[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     callPrompt(promptValue: BasePromptValue, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     predictMessages(messages: BaseMessage[], options?: string[] | CallOptions, callbacks?: Callbacks): Promise<BaseMessage>;
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a string.
+     */
     predict(text: string, options?: string[] | CallOptions, callbacks?: Callbacks): Promise<string>;
 }
+/**
+ * An abstract class that extends BaseChatModel and provides a simple
+ * implementation of _generate.
+ */
 export declare abstract class SimpleChatModel extends BaseChatModel {
     abstract _call(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<string>;
     _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;

package/dist/chat_models/base.js

@@ -1,6 +1,11 @@
 import { AIMessage, HumanMessage, RUN_KEY, } from "../schema/index.js";
 import { BaseLanguageModel, } from "../base_language/index.js";
 import { CallbackManager, } from "../callbacks/manager.js";
+/**
+ * Creates a transform stream for encoding chat message chunks.
+ * @deprecated Use {@link BytesOutputParser} instead
+ * @returns A TransformStream instance that encodes chat message chunks.
+ */
 export function createChatMessageChunkEncoderStream() {
     const textEncoder = new TextEncoder();
     return new TransformStream({
@@ -9,6 +14,10 @@ export function createChatMessageChunkEncoderStream() {
         },
     });
 }
+/**
+ * Base class for chat models. It extends the BaseLanguageModel class and
+ * provides methods for generating chat based on input messages.
+ */
 export class BaseChatModel extends BaseLanguageModel {
     constructor(fields) {
         super(fields);
@@ -26,6 +35,12 @@ export class BaseChatModel extends BaseLanguageModel {
         }
         return [runnableConfig, callOptions];
     }
+    /**
+     * Invokes the chat model with a single input.
+     * @param input The input for the language model.
+     * @param options The call options.
+     * @returns A Promise that resolves to a BaseMessageChunk.
+     */
     async invoke(input, options) {
         const promptValue = BaseChatModel._convertInputToPromptValue(input);
         const result = await this.generatePrompt([promptValue], options, options?.callbacks);
@@ -75,6 +90,13 @@ export class BaseChatModel extends BaseLanguageModel {
             })));
         }
     }
+    /**
+     * Generates chat based on the input messages.
+     * @param messages An array of arrays of BaseMessage instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     async generate(messages, options, callbacks) {
         // parse call options
         let parsedOptions;
@@ -138,28 +160,67 @@ export class BaseChatModel extends BaseLanguageModel {
     _modelType() {
         return "base_chat_model";
     }
+    /**
+     * Generates a prompt based on the input prompt values.
+     * @param promptValues An array of BasePromptValue instances.
+     * @param options The call options or an array of stop sequences.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to an LLMResult.
+     */
     async generatePrompt(promptValues, options, callbacks) {
         const promptMessages = promptValues.map((promptValue) => promptValue.toChatMessages());
         return this.generate(promptMessages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async call(messages, options, callbacks) {
         const result = await this.generate([messages], options, callbacks);
         const generations = result.generations;
         return generations[0][0].message;
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async callPrompt(promptValue, options, callbacks) {
         const promptMessages = promptValue.toChatMessages();
         return this.call(promptMessages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a BaseMessage.
+     */
     async predictMessages(messages, options, callbacks) {
         return this.call(messages, options, callbacks);
     }
+    /**
+     * 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.
+     * @param callbacks The callbacks for the language model.
+     * @returns A Promise that resolves to a string.
+     */
     async predict(text, options, callbacks) {
         const message = new HumanMessage(text);
         const result = await this.call([message], options, callbacks);
         return result.content;
     }
 }
+/**
+ * An abstract class that extends BaseChatModel and provides a simple
+ * implementation of _generate.
+ */
 export class SimpleChatModel extends BaseChatModel {
     async _generate(messages, options, runManager) {
         const text = await this._call(messages, options, runManager);

package/dist/chat_models/googlepalm.cjs

@@ -13,6 +13,9 @@ function getMessageAuthor(message) {
     }
     return message.name ?? type;
 }
+/**
+ * A class that wraps the Google Palm chat model.
+ */
 class ChatGooglePaLM extends base_js_1.BaseChatModel {
     static lc_name() {
         return "ChatGooglePaLM";

package/dist/chat_models/googlepalm.d.ts

@@ -2,6 +2,9 @@ import type { protos } from "@google-ai/generativelanguage";
 import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
 import { BaseMessage, ChatResult } from "../schema/index.js";
 import { BaseChatModel, BaseChatModelParams } from "./base.js";
+/**
+ * An interface defining the input to the ChatGooglePaLM class.
+ */
 export interface GooglePaLMChatInput extends BaseChatModelParams {
     /**
      * Model Name to use
@@ -50,6 +53,9 @@ export interface GooglePaLMChatInput extends BaseChatModelParams {
      */
     apiKey?: string;
 }
+/**
+ * A class that wraps the Google Palm chat model.
+ */
 export declare class ChatGooglePaLM extends BaseChatModel implements GooglePaLMChatInput {
     static lc_name(): string;
     lc_serializable: boolean;

package/dist/chat_models/googlepalm.js

@@ -10,6 +10,9 @@ function getMessageAuthor(message) {
     }
     return message.name ?? type;
 }
+/**
+ * A class that wraps the Google Palm chat model.
+ */
 export class ChatGooglePaLM extends BaseChatModel {
     static lc_name() {
         return "ChatGooglePaLM";

package/dist/chat_models/googlevertexai.cjs

@@ -4,6 +4,9 @@ exports.ChatGoogleVertexAI = exports.GoogleVertexAIChatMessage = void 0;
 const base_js_1 = require("./base.cjs");
 const index_js_1 = require("../schema/index.cjs");
 const googlevertexai_connection_js_1 = require("../util/googlevertexai-connection.cjs");
+/**
+ * Represents a chat message in the Google Vertex AI chat model.
+ */
 class GoogleVertexAIChatMessage {
     constructor(fields) {
         Object.defineProperty(this, "author", {
@@ -28,6 +31,12 @@ class GoogleVertexAIChatMessage {
         this.content = fields.content;
         this.name = fields.name;
     }
+    /**
+     * Extracts the role of a generic message and maps it to a Google Vertex
+     * AI chat author.
+     * @param message The chat message to extract the role from.
+     * @returns The role of the message mapped to a Google Vertex AI chat author.
+     */
     static extractGenericMessageCustomRole(message) {
         if (message.role !== "system" &&
             message.role !== "bot" &&
@@ -37,6 +46,12 @@ class GoogleVertexAIChatMessage {
         }
         return message.role;
     }
+    /**
+     * Maps a message type to a Google Vertex AI chat author.
+     * @param message The message to map.
+     * @param model The model to use for mapping.
+     * @returns The message type mapped to a Google Vertex AI chat author.
+     */
     static mapMessageTypeToVertexChatAuthor(message, model) {
         const type = message._getType();
         switch (type) {
@@ -55,6 +70,12 @@ class GoogleVertexAIChatMessage {
                 throw new Error(`Unknown / unsupported message type: ${message}`);
         }
     }
+    /**
+     * Creates a new Google Vertex AI chat message from a base message.
+     * @param message The base message to convert.
+     * @param model The model to use for conversion.
+     * @returns A new Google Vertex AI chat message.
+     */
     static fromChatMessage(message, model) {
         return new GoogleVertexAIChatMessage({
             author: GoogleVertexAIChatMessage.mapMessageTypeToVertexChatAuthor(message, model),
@@ -164,6 +185,11 @@ class ChatGoogleVertexAI extends base_js_1.BaseChatModel {
     _llmType() {
         return "googlevertexai";
     }
+    /**
+     * Creates an instance of the Google Vertex AI chat model.
+     * @param messages The messages for the model instance.
+     * @returns A new instance of the Google Vertex AI chat model.
+     */
     createInstance(messages) {
         let context = "";
         let conversationMessages = messages;
@@ -197,6 +223,12 @@ class ChatGoogleVertexAI extends base_js_1.BaseChatModel {
         };
         return instance;
     }
+    /**
+     * Converts a prediction from the Google Vertex AI chat model to a chat
+     * generation.
+     * @param prediction The prediction to convert.
+     * @returns The converted chat generation.
+     */
     static convertPrediction(prediction) {
         const message = prediction?.candidates[0];
         return {

package/dist/chat_models/googlevertexai.d.ts

@@ -11,33 +11,71 @@ export interface ChatExample {
     input: BaseMessage;
     output: BaseMessage;
 }
+/**
+ * Represents a single example exchange in the Google Vertex AI chat
+ * model.
+ */
 interface GoogleVertexAIChatExample {
     input: GoogleVertexAIChatMessage;
     output: GoogleVertexAIChatMessage;
 }
+/**
+ * Represents the author of a chat message in the Google Vertex AI chat
+ * model.
+ */
 export type GoogleVertexAIChatAuthor = "user" | "bot" | "system" | "context";
 export type GoogleVertexAIChatMessageFields = {
     author?: GoogleVertexAIChatAuthor;
     content: string;
     name?: string;
 };
+/**
+ * Represents a chat message in the Google Vertex AI chat model.
+ */
 export declare class GoogleVertexAIChatMessage {
     author?: GoogleVertexAIChatAuthor;
     content: string;
     name?: string;
     constructor(fields: GoogleVertexAIChatMessageFields);
+    /**
+     * Extracts the role of a generic message and maps it to a Google Vertex
+     * AI chat author.
+     * @param message The chat message to extract the role from.
+     * @returns The role of the message mapped to a Google Vertex AI chat author.
+     */
     static extractGenericMessageCustomRole(message: ChatMessage): GoogleVertexAIChatAuthor;
+    /**
+     * Maps a message type to a Google Vertex AI chat author.
+     * @param message The message to map.
+     * @param model The model to use for mapping.
+     * @returns The message type mapped to a Google Vertex AI chat author.
+     */
     static mapMessageTypeToVertexChatAuthor(message: BaseMessage, model: string): GoogleVertexAIChatAuthor;
+    /**
+     * Creates a new Google Vertex AI chat message from a base message.
+     * @param message The base message to convert.
+     * @param model The model to use for conversion.
+     * @returns A new Google Vertex AI chat message.
+     */
     static fromChatMessage(message: BaseMessage, model: string): GoogleVertexAIChatMessage;
 }
+/**
+ * Represents an instance of the Google Vertex AI chat model.
+ */
 export interface GoogleVertexAIChatInstance {
     context?: string;
     examples?: GoogleVertexAIChatExample[];
     messages: GoogleVertexAIChatMessage[];
 }
+/**
+ * Defines the prediction output of the Google Vertex AI chat model.
+ */
 export interface GoogleVertexAIChatPrediction extends GoogleVertexAIBasePrediction {
     candidates: GoogleVertexAIChatMessage[];
 }
+/**
+ * Defines the input to the Google Vertex AI chat model.
+ */
 export interface GoogleVertexAIChatInput extends GoogleVertexAIBaseLLMInput {
     /** Instructions how the model should respond */
     context?: string;
@@ -72,7 +110,18 @@ export declare class ChatGoogleVertexAI extends BaseChatModel implements GoogleV
     _combineLLMOutput(): LLMResult["llmOutput"];
     _generate(messages: BaseMessage[], options: this["ParsedCallOptions"]): Promise<ChatResult>;
     _llmType(): string;
+    /**
+     * Creates an instance of the Google Vertex AI chat model.
+     * @param messages The messages for the model instance.
+     * @returns A new instance of the Google Vertex AI chat model.
+     */
     createInstance(messages: BaseMessage[]): GoogleVertexAIChatInstance;
+    /**
+     * Converts a prediction from the Google Vertex AI chat model to a chat
+     * generation.
+     * @param prediction The prediction to convert.
+     * @returns The converted chat generation.
+     */
     static convertPrediction(prediction: GoogleVertexAIChatPrediction): ChatGeneration;
 }
 export {};

package/dist/chat_models/googlevertexai.js

@@ -1,6 +1,9 @@
 import { BaseChatModel } from "./base.js";
 import { AIMessage, ChatMessage, } from "../schema/index.js";
 import { GoogleVertexAIConnection } from "../util/googlevertexai-connection.js";
+/**
+ * Represents a chat message in the Google Vertex AI chat model.
+ */
 export class GoogleVertexAIChatMessage {
     constructor(fields) {
         Object.defineProperty(this, "author", {
@@ -25,6 +28,12 @@ export class GoogleVertexAIChatMessage {
         this.content = fields.content;
         this.name = fields.name;
     }
+    /**
+     * Extracts the role of a generic message and maps it to a Google Vertex
+     * AI chat author.
+     * @param message The chat message to extract the role from.
+     * @returns The role of the message mapped to a Google Vertex AI chat author.
+     */
     static extractGenericMessageCustomRole(message) {
         if (message.role !== "system" &&
             message.role !== "bot" &&
@@ -34,6 +43,12 @@ export class GoogleVertexAIChatMessage {
         }
         return message.role;
     }
+    /**
+     * Maps a message type to a Google Vertex AI chat author.
+     * @param message The message to map.
+     * @param model The model to use for mapping.
+     * @returns The message type mapped to a Google Vertex AI chat author.
+     */
     static mapMessageTypeToVertexChatAuthor(message, model) {
         const type = message._getType();
         switch (type) {
@@ -52,6 +67,12 @@ export class GoogleVertexAIChatMessage {
                 throw new Error(`Unknown / unsupported message type: ${message}`);
         }
     }
+    /**
+     * Creates a new Google Vertex AI chat message from a base message.
+     * @param message The base message to convert.
+     * @param model The model to use for conversion.
+     * @returns A new Google Vertex AI chat message.
+     */
     static fromChatMessage(message, model) {
         return new GoogleVertexAIChatMessage({
             author: GoogleVertexAIChatMessage.mapMessageTypeToVertexChatAuthor(message, model),
@@ -160,6 +181,11 @@ export class ChatGoogleVertexAI extends BaseChatModel {
     _llmType() {
         return "googlevertexai";
     }
+    /**
+     * Creates an instance of the Google Vertex AI chat model.
+     * @param messages The messages for the model instance.
+     * @returns A new instance of the Google Vertex AI chat model.
+     */
     createInstance(messages) {
         let context = "";
         let conversationMessages = messages;
@@ -193,6 +219,12 @@ export class ChatGoogleVertexAI extends BaseChatModel {
         };
         return instance;
     }
+    /**
+     * Converts a prediction from the Google Vertex AI chat model to a chat
+     * generation.
+     * @param prediction The prediction to convert.
+     * @returns The converted chat generation.
+     */
     static convertPrediction(prediction) {
         const message = prediction?.candidates[0];
         return {