langchain 0.0.192 → 0.0.193

package/dist/chat_models/googlepalm.d.ts

@@ -59,6 +59,30 @@ export interface GooglePaLMChatInput extends BaseChatModelParams {
 }
 /**
  * A class that wraps the Google Palm chat model.
+ * @example
+ * ```typescript
+ * const model = new ChatGooglePaLM({
+ *   apiKey: "<YOUR API KEY>",
+ *   temperature: 0.7,
+ *   modelName: "models/chat-bison-001",
+ *   topK: 40,
+ *   topP: 1,
+ *   examples: [
+ *     {
+ *       input: new HumanMessage("What is your favorite sock color?"),
+ *       output: new AIMessage("My favorite sock color be arrrr-ange!"),
+ *     },
+ *   ],
+ * });
+ * const questions = [
+ *   new SystemMessage(
+ *     "You are a funny assistant that answers in pirate language."
+ *   ),
+ *   new HumanMessage("What is your favorite food?"),
+ * ];
+ * const res = await model.call(questions);
+ * console.log({ res });
+ * ```
  */
 export declare class ChatGooglePaLM extends BaseChatModel implements GooglePaLMChatInput {
     static lc_name(): string;

package/dist/chat_models/googlepalm.js

@@ -12,6 +12,30 @@ function getMessageAuthor(message) {
 }
 /**
  * A class that wraps the Google Palm chat model.
+ * @example
+ * ```typescript
+ * const model = new ChatGooglePaLM({
+ *   apiKey: "<YOUR API KEY>",
+ *   temperature: 0.7,
+ *   modelName: "models/chat-bison-001",
+ *   topK: 40,
+ *   topP: 1,
+ *   examples: [
+ *     {
+ *       input: new HumanMessage("What is your favorite sock color?"),
+ *       output: new AIMessage("My favorite sock color be arrrr-ange!"),
+ *     },
+ *   ],
+ * });
+ * const questions = [
+ *   new SystemMessage(
+ *     "You are a funny assistant that answers in pirate language."
+ *   ),
+ *   new HumanMessage("What is your favorite food?"),
+ * ];
+ * const res = await model.call(questions);
+ * console.log({ res });
+ * ```
  */
 export class ChatGooglePaLM extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/googlevertexai/index.cjs

@@ -17,6 +17,13 @@ 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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke("What is the capital of France?");
+ * ```
  */
 class ChatGoogleVertexAI extends common_js_1.BaseChatGoogleVertexAI {
     static lc_name() {

package/dist/chat_models/googlevertexai/index.d.ts

@@ -13,6 +13,13 @@ import { BaseChatGoogleVertexAI, GoogleVertexAIChatInput } from "./common.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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke("What is the capital of France?");
+ * ```
  */
 export declare class ChatGoogleVertexAI extends BaseChatGoogleVertexAI<GoogleAuthOptions> {
     static lc_name(): string;

package/dist/chat_models/googlevertexai/index.js

@@ -14,6 +14,13 @@ 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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke("What is the capital of France?");
+ * ```
  */
 export class ChatGoogleVertexAI extends BaseChatGoogleVertexAI {
     static lc_name() {

package/dist/chat_models/googlevertexai/web.cjs

@@ -12,6 +12,15 @@ 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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke(
+ *   "How do I implement a binary search algorithm in Python?",
+ * );
+ * ```
  */
 class ChatGoogleVertexAI extends common_js_1.BaseChatGoogleVertexAI {
     static lc_name() {

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

@@ -8,6 +8,15 @@ import { BaseChatGoogleVertexAI, GoogleVertexAIChatInput } 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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke(
+ *   "How do I implement a binary search algorithm in Python?",
+ * );
+ * ```
  */
 export declare class ChatGoogleVertexAI extends BaseChatGoogleVertexAI<WebGoogleAuthOptions> {
     static lc_name(): string;

package/dist/chat_models/googlevertexai/web.js

@@ -9,6 +9,15 @@ import { BaseChatGoogleVertexAI } 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 ChatGoogleVertexAI({
+ *   temperature: 0.7,
+ * });
+ * const result = await model.invoke(
+ *   "How do I implement a binary search algorithm in Python?",
+ * );
+ * ```
  */
 export class ChatGoogleVertexAI extends BaseChatGoogleVertexAI {
     static lc_name() {

package/dist/chat_models/iflytek_xinghuo/index.cjs

@@ -14,6 +14,14 @@ class WebSocketStream extends iflytek_websocket_stream_js_1.BaseWebSocketStream
         return new ws_1.default(url, options.protocols ?? []);
     }
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 class ChatIflytekXinghuo extends common_js_1.BaseChatIflytekXinghuo {
     async openWebSocketStream(options) {
         const host = "spark-api.xf-yun.com";

package/dist/chat_models/iflytek_xinghuo/index.d.ts

@@ -1,5 +1,13 @@
 import { BaseChatIflytekXinghuo } from "./common.js";
 import { WebSocketStreamOptions } from "../../util/iflytek_websocket_stream.js";
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 export declare class ChatIflytekXinghuo extends BaseChatIflytekXinghuo {
     openWebSocketStream<WebSocketStream>(options: WebSocketStreamOptions): Promise<WebSocketStream>;
 }

package/dist/chat_models/iflytek_xinghuo/index.js

@@ -8,6 +8,14 @@ class WebSocketStream extends BaseWebSocketStream {
         return new WebSocket(url, options.protocols ?? []);
     }
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 export class ChatIflytekXinghuo extends BaseChatIflytekXinghuo {
     async openWebSocketStream(options) {
         const host = "spark-api.xf-yun.com";

package/dist/chat_models/iflytek_xinghuo/web.cjs

@@ -8,6 +8,14 @@ class WebSocketStream extends iflytek_websocket_stream_js_1.BaseWebSocketStream
         return new WebSocket(url, options.protocols ?? []);
     }
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 class ChatIflytekXinghuo extends common_js_1.BaseChatIflytekXinghuo {
     async openWebSocketStream(options) {
         const host = "spark-api.xf-yun.com";

package/dist/chat_models/iflytek_xinghuo/web.d.ts

@@ -1,5 +1,13 @@
 import { BaseChatIflytekXinghuo } from "./common.js";
 import { WebSocketStreamOptions } from "../../util/iflytek_websocket_stream.js";
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 export declare class ChatIflytekXinghuo extends BaseChatIflytekXinghuo {
     openWebSocketStream<WebSocketStream>(options: WebSocketStreamOptions): Promise<WebSocketStream>;
 }

package/dist/chat_models/iflytek_xinghuo/web.js

@@ -5,6 +5,14 @@ class WebSocketStream extends BaseWebSocketStream {
         return new WebSocket(url, options.protocols ?? []);
     }
 }
+/**
+ * @example
+ * ```typescript
+ * const model = new ChatIflytekXinghuo();
+ * const response = await model.call([new HumanMessage("Nice to meet you!")]);
+ * console.log(response);
+ * ```
+ */
 export class ChatIflytekXinghuo extends BaseChatIflytekXinghuo {
     async openWebSocketStream(options) {
         const host = "spark-api.xf-yun.com";

package/dist/chat_models/llama_cpp.cjs

@@ -9,6 +9,23 @@ const llama_cpp_js_1 = require("../util/llama_cpp.cjs");
  *  This can be installed using `npm install -S node-llama-cpp` and the minimum
  *  version supported in version 2.0.0.
  *  This also requires that have a locally built version of Llama2 installed.
+ * @example
+ * ```typescript
+ * // Initialize the ChatLlamaCpp model with the path to the model binary file.
+ * const model = new ChatLlamaCpp({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ *   temperature: 0.5,
+ * });
+ *
+ * // Call the model with a message and await the response.
+ * const response = await model.call([
+ *   new HumanMessage({ content: "My name is John." }),
+ * ]);
+ *
+ * // Log the response to the console.
+ * console.log({ response });
+ *
+ * ```
  */
 class ChatLlamaCpp extends base_js_1.SimpleChatModel {
     static lc_name() {

package/dist/chat_models/llama_cpp.d.ts

@@ -20,6 +20,23 @@ export interface LlamaCppCallOptions extends BaseLanguageModelCallOptions {
  *  This can be installed using `npm install -S node-llama-cpp` and the minimum
  *  version supported in version 2.0.0.
  *  This also requires that have a locally built version of Llama2 installed.
+ * @example
+ * ```typescript
+ * // Initialize the ChatLlamaCpp model with the path to the model binary file.
+ * const model = new ChatLlamaCpp({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ *   temperature: 0.5,
+ * });
+ *
+ * // Call the model with a message and await the response.
+ * const response = await model.call([
+ *   new HumanMessage({ content: "My name is John." }),
+ * ]);
+ *
+ * // Log the response to the console.
+ * console.log({ response });
+ *
+ * ```
  */
 export declare class ChatLlamaCpp extends SimpleChatModel<LlamaCppCallOptions> {
     CallOptions: LlamaCppCallOptions;

package/dist/chat_models/llama_cpp.js

@@ -6,6 +6,23 @@ import { createLlamaModel, createLlamaContext, } from "../util/llama_cpp.js";
  *  This can be installed using `npm install -S node-llama-cpp` and the minimum
  *  version supported in version 2.0.0.
  *  This also requires that have a locally built version of Llama2 installed.
+ * @example
+ * ```typescript
+ * // Initialize the ChatLlamaCpp model with the path to the model binary file.
+ * const model = new ChatLlamaCpp({
+ *   modelPath: "/Replace/with/path/to/your/model/gguf-llama2-q4_0.bin",
+ *   temperature: 0.5,
+ * });
+ *
+ * // Call the model with a message and await the response.
+ * const response = await model.call([
+ *   new HumanMessage({ content: "My name is John." }),
+ * ]);
+ *
+ * // Log the response to the console.
+ * console.log({ response });
+ *
+ * ```
  */
 export class ChatLlamaCpp extends SimpleChatModel {
     static lc_name() {

package/dist/chat_models/minimax.cjs

@@ -52,6 +52,33 @@ function messageToMinimaxRole(message) {
  *
  * To use you should have the `MINIMAX_GROUP_ID` and `MINIMAX_API_KEY`
  * environment variable set.
+ * @example
+ * ```typescript
+ * // Define a chat prompt with a system message setting the context for translation
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   SystemMessagePromptTemplate.fromTemplate(
+ *     "You are a helpful assistant that translates {input_language} to {output_language}.",
+ *   ),
+ *   HumanMessagePromptTemplate.fromTemplate("{text}"),
+ * ]);
+ *
+ * // Create a new LLMChain with the chat model and the defined prompt
+ * const chainB = new LLMChain({
+ *   prompt: chatPrompt,
+ *   llm: new ChatMinimax({ temperature: 0.01 }),
+ * });
+ *
+ * // Call the chain with the input language, output language, and the text to translate
+ * const resB = await chainB.call({
+ *   input_language: "English",
+ *   output_language: "Chinese",
+ *   text: "I love programming.",
+ * });
+ *
+ * // Log the result
+ * console.log({ resB });
+ *
+ * ```
  */
 class ChatMinimax extends base_js_1.BaseChatModel {
     static lc_name() {

package/dist/chat_models/minimax.d.ts

@@ -184,6 +184,33 @@ export interface ChatMinimaxCallOptions extends BaseFunctionCallOptions {
  *
  * To use you should have the `MINIMAX_GROUP_ID` and `MINIMAX_API_KEY`
  * environment variable set.
+ * @example
+ * ```typescript
+ * // Define a chat prompt with a system message setting the context for translation
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   SystemMessagePromptTemplate.fromTemplate(
+ *     "You are a helpful assistant that translates {input_language} to {output_language}.",
+ *   ),
+ *   HumanMessagePromptTemplate.fromTemplate("{text}"),
+ * ]);
+ *
+ * // Create a new LLMChain with the chat model and the defined prompt
+ * const chainB = new LLMChain({
+ *   prompt: chatPrompt,
+ *   llm: new ChatMinimax({ temperature: 0.01 }),
+ * });
+ *
+ * // Call the chain with the input language, output language, and the text to translate
+ * const resB = await chainB.call({
+ *   input_language: "English",
+ *   output_language: "Chinese",
+ *   text: "I love programming.",
+ * });
+ *
+ * // Log the result
+ * console.log({ resB });
+ *
+ * ```
  */
 export declare class ChatMinimax extends BaseChatModel<ChatMinimaxCallOptions> implements MinimaxChatInput {
     static lc_name(): string;

package/dist/chat_models/minimax.js

@@ -49,6 +49,33 @@ function messageToMinimaxRole(message) {
  *
  * To use you should have the `MINIMAX_GROUP_ID` and `MINIMAX_API_KEY`
  * environment variable set.
+ * @example
+ * ```typescript
+ * // Define a chat prompt with a system message setting the context for translation
+ * const chatPrompt = ChatPromptTemplate.fromMessages([
+ *   SystemMessagePromptTemplate.fromTemplate(
+ *     "You are a helpful assistant that translates {input_language} to {output_language}.",
+ *   ),
+ *   HumanMessagePromptTemplate.fromTemplate("{text}"),
+ * ]);
+ *
+ * // Create a new LLMChain with the chat model and the defined prompt
+ * const chainB = new LLMChain({
+ *   prompt: chatPrompt,
+ *   llm: new ChatMinimax({ temperature: 0.01 }),
+ * });
+ *
+ * // Call the chain with the input language, output language, and the text to translate
+ * const resB = await chainB.call({
+ *   input_language: "English",
+ *   output_language: "Chinese",
+ *   text: "I love programming.",
+ * });
+ *
+ * // Log the result
+ * console.log({ resB });
+ *
+ * ```
  */
 export class ChatMinimax extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/ollama.cjs

@@ -8,6 +8,30 @@ const index_js_1 = require("../schema/index.cjs");
  * A class that enables calls to the Ollama API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   [
+ *     "system",
+ *     `You are an expert translator. Format all responses as JSON objects with two keys: "original" and "translated".`,
+ *   ],
+ *   ["human", `Translate "{input}" into {language}.`],
+ * ]);
+ *
+ * const model = new ChatOllama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ *   format: "json",
+ * });
+ *
+ * const chain = prompt.pipe(model);
+ *
+ * const result = await chain.invoke({
+ *   input: "I love programming",
+ *   language: "German",
+ * });
+ *
+ * ```
  */
 class ChatOllama extends base_js_1.SimpleChatModel {
     static lc_name() {

package/dist/chat_models/ollama.d.ts

@@ -14,6 +14,30 @@ export interface OllamaCallOptions extends BaseLanguageModelCallOptions {
  * A class that enables calls to the Ollama API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   [
+ *     "system",
+ *     `You are an expert translator. Format all responses as JSON objects with two keys: "original" and "translated".`,
+ *   ],
+ *   ["human", `Translate "{input}" into {language}.`],
+ * ]);
+ *
+ * const model = new ChatOllama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ *   format: "json",
+ * });
+ *
+ * const chain = prompt.pipe(model);
+ *
+ * const result = await chain.invoke({
+ *   input: "I love programming",
+ *   language: "German",
+ * });
+ *
+ * ```
  */
 export declare class ChatOllama extends SimpleChatModel<OllamaCallOptions> implements OllamaInput {
     static lc_name(): string;

package/dist/chat_models/ollama.js

@@ -5,6 +5,30 @@ import { AIMessageChunk, ChatGenerationChunk, ChatMessage, } from "../schema/ind
  * A class that enables calls to the Ollama API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the OllamaInput interface.
+ * @example
+ * ```typescript
+ * const prompt = ChatPromptTemplate.fromMessages([
+ *   [
+ *     "system",
+ *     `You are an expert translator. Format all responses as JSON objects with two keys: "original" and "translated".`,
+ *   ],
+ *   ["human", `Translate "{input}" into {language}.`],
+ * ]);
+ *
+ * const model = new ChatOllama({
+ *   baseUrl: "http://api.example.com",
+ *   model: "llama2",
+ *   format: "json",
+ * });
+ *
+ * const chain = prompt.pipe(model);
+ *
+ * const result = await chain.invoke({
+ *   input: "I love programming",
+ *   language: "German",
+ * });
+ *
+ * ```
  */
 export class ChatOllama extends SimpleChatModel {
     static lc_name() {

package/dist/chat_models/openai.cjs

@@ -128,6 +128,21 @@ function convertMessagesToOpenAIParams(messages) {
  * https://platform.openai.com/docs/api-reference/chat/create |
  * `openai.createChatCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * // Create a new instance of ChatOpenAI with specific temperature and model name settings
+ * const model = new ChatOpenAI({
+ *   temperature: 0.9,
+ *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ * });
+ *
+ * // Invoke the model with a message and await the response
+ * const message = await model.invoke("Hi there!");
+ *
+ * // Log the response to the console
+ * console.log(message);
+ *
+ * ```
  */
 class ChatOpenAI extends base_js_1.BaseChatModel {
     static lc_name() {

package/dist/chat_models/openai.d.ts

@@ -41,6 +41,21 @@ export interface ChatOpenAICallOptions extends OpenAICallOptions, BaseFunctionCa
  * https://platform.openai.com/docs/api-reference/chat/create |
  * `openai.createChatCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * // Create a new instance of ChatOpenAI with specific temperature and model name settings
+ * const model = new ChatOpenAI({
+ *   temperature: 0.9,
+ *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ * });
+ *
+ * // Invoke the model with a message and await the response
+ * const message = await model.invoke("Hi there!");
+ *
+ * // Log the response to the console
+ * console.log(message);
+ *
+ * ```
  */
 export declare class ChatOpenAI<CallOptions extends ChatOpenAICallOptions = ChatOpenAICallOptions> extends BaseChatModel<CallOptions> implements OpenAIChatInput, AzureOpenAIInput {
     static lc_name(): string;

package/dist/chat_models/openai.js

@@ -125,6 +125,21 @@ function convertMessagesToOpenAIParams(messages) {
  * https://platform.openai.com/docs/api-reference/chat/create |
  * `openai.createChatCompletion`} can be passed through {@link modelKwargs}, even
  * if not explicitly available on this class.
+ * @example
+ * ```typescript
+ * // Create a new instance of ChatOpenAI with specific temperature and model name settings
+ * const model = new ChatOpenAI({
+ *   temperature: 0.9,
+ *   modelName: "ft:gpt-3.5-turbo-0613:{ORG_NAME}::{MODEL_ID}",
+ * });
+ *
+ * // Invoke the model with a message and await the response
+ * const message = await model.invoke("Hi there!");
+ *
+ * // Log the response to the console
+ * console.log(message);
+ *
+ * ```
  */
 export class ChatOpenAI extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/yandex.cjs

@@ -26,6 +26,20 @@ function _parseChatHistory(history) {
     }
     return [chatHistory, instruction];
 }
+/**
+ * @example
+ * ```typescript
+ * const chat = new ChatYandexGPT({});
+ * // The assistant is set to translate English to French.
+ * const res = await chat.call([
+ *   new SystemMessage(
+ *     "You are a helpful assistant that translates English to French."
+ *   ),
+ *   new HumanMessage("I love programming."),
+ * ]);
+ * console.log(res);
+ * ```
+ */
 class ChatYandexGPT extends base_js_1.BaseChatModel {
     constructor(fields) {
         super(fields ?? {});

package/dist/chat_models/yandex.d.ts

@@ -2,6 +2,20 @@ import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
 import { YandexGPTInputs } from "../llms/yandex.js";
 import { BaseMessage, ChatResult } from "../schema/index.js";
 import { BaseChatModel } from "./base.js";
+/**
+ * @example
+ * ```typescript
+ * const chat = new ChatYandexGPT({});
+ * // The assistant is set to translate English to French.
+ * const res = await chat.call([
+ *   new SystemMessage(
+ *     "You are a helpful assistant that translates English to French."
+ *   ),
+ *   new HumanMessage("I love programming."),
+ * ]);
+ * console.log(res);
+ * ```
+ */
 export declare class ChatYandexGPT extends BaseChatModel {
     apiKey?: string;
     iamToken?: string;

package/dist/chat_models/yandex.js

@@ -23,6 +23,20 @@ function _parseChatHistory(history) {
     }
     return [chatHistory, instruction];
 }
+/**
+ * @example
+ * ```typescript
+ * const chat = new ChatYandexGPT({});
+ * // The assistant is set to translate English to French.
+ * const res = await chat.call([
+ *   new SystemMessage(
+ *     "You are a helpful assistant that translates English to French."
+ *   ),
+ *   new HumanMessage("I love programming."),
+ * ]);
+ * console.log(res);
+ * ```
+ */
 export class ChatYandexGPT extends BaseChatModel {
     constructor(fields) {
         super(fields ?? {});