langchain 0.0.192 → 0.0.194

package/dist/chains/sequential_chain.d.ts

@@ -17,6 +17,49 @@ export interface SequentialChainInput extends ChainInputs {
 }
 /**
  * Chain where the outputs of one chain feed directly into next.
+ * @example
+ * ```typescript
+ * const promptTemplate = new PromptTemplate({
+ *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.
+ * Title: {title}
+ * Era: {era}
+ * Playwright: This is a synopsis for the above play:`,
+ *   inputVariables: ["title", "era"],
+ * });
+
+ * const reviewPromptTemplate = new PromptTemplate({
+ *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.
+ *
+ *     Play Synopsis:
+ *     {synopsis}
+ *     Review from a New York Times play critic of the above play:`,
+ *   inputVariables: ["synopsis"],
+ * });
+
+ * const overallChain = new SequentialChain({
+ *   chains: [
+ *     new LLMChain({
+ *       llm: new ChatOpenAI({ temperature: 0 }),
+ *       prompt: promptTemplate,
+ *       outputKey: "synopsis",
+ *     }),
+ *     new LLMChain({
+ *       llm: new OpenAI({ temperature: 0 }),
+ *       prompt: reviewPromptTemplate,
+ *       outputKey: "review",
+ *     }),
+ *   ],
+ *   inputVariables: ["era", "title"],
+ *   outputVariables: ["synopsis", "review"],
+ *   verbose: true,
+ * });
+
+ * const chainExecutionResult = await overallChain.call({
+ *   title: "Tragedy at sunset on the beach",
+ *   era: "Victorian England",
+ * });
+ * console.log(chainExecutionResult);
+ * ```
  */
 export declare class SequentialChain extends BaseChain implements SequentialChainInput {
     static lc_name(): string;

package/dist/chains/sequential_chain.js

@@ -7,6 +7,49 @@ function formatSet(input) {
 }
 /**
  * Chain where the outputs of one chain feed directly into next.
+ * @example
+ * ```typescript
+ * const promptTemplate = new PromptTemplate({
+ *   template: `You are a playwright. Given the title of play and the era it is set in, it is your job to write a synopsis for that title.
+ * Title: {title}
+ * Era: {era}
+ * Playwright: This is a synopsis for the above play:`,
+ *   inputVariables: ["title", "era"],
+ * });
+
+ * const reviewPromptTemplate = new PromptTemplate({
+ *   template: `You are a play critic from the New York Times. Given the synopsis of play, it is your job to write a review for that play.
+ *
+ *     Play Synopsis:
+ *     {synopsis}
+ *     Review from a New York Times play critic of the above play:`,
+ *   inputVariables: ["synopsis"],
+ * });
+
+ * const overallChain = new SequentialChain({
+ *   chains: [
+ *     new LLMChain({
+ *       llm: new ChatOpenAI({ temperature: 0 }),
+ *       prompt: promptTemplate,
+ *       outputKey: "synopsis",
+ *     }),
+ *     new LLMChain({
+ *       llm: new OpenAI({ temperature: 0 }),
+ *       prompt: reviewPromptTemplate,
+ *       outputKey: "review",
+ *     }),
+ *   ],
+ *   inputVariables: ["era", "title"],
+ *   outputVariables: ["synopsis", "review"],
+ *   verbose: true,
+ * });
+
+ * const chainExecutionResult = await overallChain.call({
+ *   title: "Tragedy at sunset on the beach",
+ *   era: "Victorian England",
+ * });
+ * console.log(chainExecutionResult);
+ * ```
  */
 export class SequentialChain extends BaseChain {
     static lc_name() {

package/dist/chains/sql_db/sql_db_chain.cjs

@@ -21,6 +21,15 @@ const sql_utils_js_1 = require("../../util/sql_utils.cjs");
  * to limit which tables can/cannot be accessed.
  *
  * @link See https://js.langchain.com/docs/security for more information.
+ * @example
+ * ```typescript
+ * const chain = new SqlDatabaseChain({
+ *   llm: new OpenAI({ temperature: 0 }),
+ *   database: new SqlDatabase({ ...config }),
+ * });
+ *
+ * const result = await chain.run("How many tracks are there?");
+ * ```
  */
 class SqlDatabaseChain extends base_js_1.BaseChain {
     static lc_name() {

package/dist/chains/sql_db/sql_db_chain.d.ts

@@ -33,6 +33,15 @@ export interface SqlDatabaseChainInput extends ChainInputs {
  * to limit which tables can/cannot be accessed.
  *
  * @link See https://js.langchain.com/docs/security for more information.
+ * @example
+ * ```typescript
+ * const chain = new SqlDatabaseChain({
+ *   llm: new OpenAI({ temperature: 0 }),
+ *   database: new SqlDatabase({ ...config }),
+ * });
+ *
+ * const result = await chain.run("How many tracks are there?");
+ * ```
  */
 export declare class SqlDatabaseChain extends BaseChain {
     static lc_name(): string;

package/dist/chains/sql_db/sql_db_chain.js

@@ -18,6 +18,15 @@ import { getPromptTemplateFromDataSource } from "../../util/sql_utils.js";
  * to limit which tables can/cannot be accessed.
  *
  * @link See https://js.langchain.com/docs/security for more information.
+ * @example
+ * ```typescript
+ * const chain = new SqlDatabaseChain({
+ *   llm: new OpenAI({ temperature: 0 }),
+ *   database: new SqlDatabase({ ...config }),
+ * });
+ *
+ * const result = await chain.run("How many tracks are there?");
+ * ```
  */
 export class SqlDatabaseChain extends BaseChain {
     static lc_name() {

package/dist/chat_models/anthropic.cjs

@@ -53,7 +53,15 @@ exports.DEFAULT_STOP_SEQUENCES = [sdk_1.HUMAN_PROMPT];
  * https://console.anthropic.com/docs/api/reference |
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
- *
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({
+ *   temperature: 0.9,
+ *   anthropicApiKey: 'YOUR-API-KEY',
+ * });
+ * const res = await model.invoke({ input: 'Hello!' });
+ * console.log(res);
+ * ```
  */
 class ChatAnthropic extends base_js_1.BaseChatModel {
     static lc_name() {

package/dist/chat_models/anthropic.d.ts

@@ -69,7 +69,15 @@ type Kwargs = Record<string, any>;
  * https://console.anthropic.com/docs/api/reference |
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
- *
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({
+ *   temperature: 0.9,
+ *   anthropicApiKey: 'YOUR-API-KEY',
+ * });
+ * const res = await model.invoke({ input: 'Hello!' });
+ * console.log(res);
+ * ```
  */
 export declare class ChatAnthropic<CallOptions extends BaseLanguageModelCallOptions = BaseLanguageModelCallOptions> extends BaseChatModel<CallOptions> implements AnthropicInput {
     static lc_name(): string;

package/dist/chat_models/anthropic.js

@@ -50,7 +50,15 @@ export const DEFAULT_STOP_SEQUENCES = [HUMAN_PROMPT];
  * https://console.anthropic.com/docs/api/reference |
  * `anthropic.complete`} can be passed through {@link invocationKwargs},
  * even if not explicitly available on this class.
- *
+ * @example
+ * ```typescript
+ * const model = new ChatAnthropic({
+ *   temperature: 0.9,
+ *   anthropicApiKey: 'YOUR-API-KEY',
+ * });
+ * const res = await model.invoke({ input: 'Hello!' });
+ * console.log(res);
+ * ```
  */
 export class ChatAnthropic extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/baiduwenxin.cjs

@@ -48,6 +48,26 @@ function messageToWenxinRole(message) {
  *
  * @augments BaseLLM
  * @augments BaiduERNIEInput
+ * @example
+ * ```typescript
+ * const ernieTurbo = new ChatBaiduWenxin({
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const ernie = new ChatBaiduWenxin({
+ *   modelName: "ERNIE-Bot",
+ *   temperature: 1,
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const messages = [new HumanMessage("Hello")];
+ *
+ * let res = await ernieTurbo.call(messages);
+ *
+ * res = await ernie.call(messages);
+ * ```
  */
 class ChatBaiduWenxin extends base_js_1.BaseChatModel {
     static lc_name() {

package/dist/chat_models/baiduwenxin.d.ts

@@ -73,6 +73,26 @@ declare interface BaiduWenxinChatInput {
  *
  * @augments BaseLLM
  * @augments BaiduERNIEInput
+ * @example
+ * ```typescript
+ * const ernieTurbo = new ChatBaiduWenxin({
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const ernie = new ChatBaiduWenxin({
+ *   modelName: "ERNIE-Bot",
+ *   temperature: 1,
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const messages = [new HumanMessage("Hello")];
+ *
+ * let res = await ernieTurbo.call(messages);
+ *
+ * res = await ernie.call(messages);
+ * ```
  */
 export declare class ChatBaiduWenxin extends BaseChatModel implements BaiduWenxinChatInput {
     static lc_name(): string;

package/dist/chat_models/baiduwenxin.js

@@ -45,6 +45,26 @@ function messageToWenxinRole(message) {
  *
  * @augments BaseLLM
  * @augments BaiduERNIEInput
+ * @example
+ * ```typescript
+ * const ernieTurbo = new ChatBaiduWenxin({
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const ernie = new ChatBaiduWenxin({
+ *   modelName: "ERNIE-Bot",
+ *   temperature: 1,
+ *   baiduApiKey: "YOUR-API-KEY",
+ *   baiduSecretKey: "YOUR-SECRET-KEY",
+ * });
+ *
+ * const messages = [new HumanMessage("Hello")];
+ *
+ * let res = await ernieTurbo.call(messages);
+ *
+ * res = await ernie.call(messages);
+ * ```
  */
 export class ChatBaiduWenxin extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/base.cjs

@@ -72,6 +72,7 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
             const extra = {
                 options: callOptions,
                 invocation_params: this?.invocationParams(callOptions),
+                batch_size: 1,
             };
             const runManagers = await callbackManager_?.handleChatModelStart(this.toJSON(), [messages], undefined, undefined, extra, undefined, undefined, runnableConfig.runName);
             let generationChunk;
@@ -104,6 +105,7 @@ class BaseChatModel extends index_js_2.BaseLanguageModel {
         const extra = {
             options: parsedOptions,
             invocation_params: this?.invocationParams(parsedOptions),
+            batch_size: 1,
         };
         const runManagers = await callbackManager_?.handleChatModelStart(this.toJSON(), baseMessages, undefined, undefined, extra, undefined, undefined, handledOptions.runName);
         // generate results

package/dist/chat_models/base.d.ts

@@ -1,4 +1,4 @@
-import { BaseMessage, BasePromptValue, ChatResult, BaseMessageChunk, LLMResult, ChatGenerationChunk, BaseMessageLike } from "../schema/index.js";
+import { BaseMessage, BaseMessageChunk, BaseMessageLike, BasePromptValue, ChatGenerationChunk, ChatResult, LLMResult } from "../schema/index.js";
 import { BaseLanguageModel, BaseLanguageModelCallOptions, BaseLanguageModelInput, BaseLanguageModelParams } from "../base_language/index.js";
 import { CallbackManagerForLLMRun, Callbacks } from "../callbacks/manager.js";
 import { RunnableConfig } from "../schema/runnable/config.js";

package/dist/chat_models/base.js

@@ -68,6 +68,7 @@ export class BaseChatModel extends BaseLanguageModel {
             const extra = {
                 options: callOptions,
                 invocation_params: this?.invocationParams(callOptions),
+                batch_size: 1,
             };
             const runManagers = await callbackManager_?.handleChatModelStart(this.toJSON(), [messages], undefined, undefined, extra, undefined, undefined, runnableConfig.runName);
             let generationChunk;
@@ -100,6 +101,7 @@ export class BaseChatModel extends BaseLanguageModel {
         const extra = {
             options: parsedOptions,
             invocation_params: this?.invocationParams(parsedOptions),
+            batch_size: 1,
         };
         const runManagers = await callbackManager_?.handleChatModelStart(this.toJSON(), baseMessages, undefined, undefined, extra, undefined, undefined, handledOptions.runName);
         // generate results

package/dist/chat_models/bedrock/index.cjs

@@ -3,6 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChatBedrock = exports.convertMessagesToPrompt = exports.convertMessagesToPromptAnthropic = exports.BedrockChat = void 0;
 const credential_provider_node_1 = require("@aws-sdk/credential-provider-node");
 const web_js_1 = require("./web.cjs");
+/**
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
+ */
 class BedrockChat extends web_js_1.BedrockChat {
     static lc_name() {
         return "BedrockChat";

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

@@ -1,6 +1,17 @@
 import { BaseBedrockInput } from "../../util/bedrock.js";
 import { BedrockChat as BaseBedrockChat } from "./web.js";
 import { BaseChatModelParams } from "../base.js";
+/**
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
+ */
 export declare class BedrockChat extends BaseBedrockChat {
     static lc_name(): string;
     constructor(fields?: Partial<BaseBedrockInput> & BaseChatModelParams);

package/dist/chat_models/bedrock/index.js

@@ -1,5 +1,16 @@
 import { defaultProvider } from "@aws-sdk/credential-provider-node";
 import { BedrockChat as BaseBedrockChat } from "./web.js";
+/**
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
+ */
 export class BedrockChat extends BaseBedrockChat {
     static lc_name() {
         return "BedrockChat";

package/dist/chat_models/bedrock/web.cjs

@@ -59,6 +59,15 @@ exports.convertMessagesToPrompt = convertMessagesToPrompt;
  * Services (AWS). It uses AWS credentials for authentication and can be
  * configured with various parameters such as the model to use, the AWS
  * region, and the maximum number of tokens to generate.
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
  */
 class BedrockChat extends base_js_1.SimpleChatModel {
     get lc_aliases() {

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

@@ -22,6 +22,15 @@ export declare function convertMessagesToPrompt(messages: BaseMessage[], provide
  * Services (AWS). It uses AWS credentials for authentication and can be
  * configured with various parameters such as the model to use, the AWS
  * region, and the maximum number of tokens to generate.
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
  */
 export declare class BedrockChat extends SimpleChatModel implements BaseBedrockInput {
     model: string;

package/dist/chat_models/bedrock/web.js

@@ -54,6 +54,15 @@ export function convertMessagesToPrompt(messages, provider) {
  * Services (AWS). It uses AWS credentials for authentication and can be
  * configured with various parameters such as the model to use, the AWS
  * region, and the maximum number of tokens to generate.
+ * @example
+ * ```typescript
+ * const model = new BedrockChat({
+ *   model: "anthropic.claude-v2",
+ *   region: "us-east-1",
+ * });
+ * const res = await model.invoke([{ content: "Tell me a joke" }]);
+ * console.log(res);
+ * ```
  */
 export class BedrockChat extends SimpleChatModel {
     get lc_aliases() {

package/dist/chat_models/cloudflare_workersai.cjs

@@ -9,6 +9,21 @@ const event_source_parse_js_1 = require("../util/event-source-parse.cjs");
  * A class that enables calls to the Cloudflare Workers AI API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the CloudflareWorkersAIInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatCloudflareWorkersAI({
+ *   model: "@cf/meta/llama-2-7b-chat-int8",
+ *   cloudflareAccountId: process.env.CLOUDFLARE_ACCOUNT_ID,
+ *   cloudflareApiToken: process.env.CLOUDFLARE_API_TOKEN
+ * });
+ *
+ * const response = await model.invoke([
+ *   ["system", "You are a helpful assistant that translates English to German."],
+ *   ["human", `Translate "I love programming".`]
+ * ]);
+ *
+ * console.log(response);
+ * ```
  */
 class ChatCloudflareWorkersAI extends base_js_1.SimpleChatModel {
     static lc_name() {

package/dist/chat_models/cloudflare_workersai.d.ts

@@ -13,6 +13,21 @@ export interface ChatCloudflareWorkersAICallOptions extends BaseLanguageModelCal
  * A class that enables calls to the Cloudflare Workers AI API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the CloudflareWorkersAIInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatCloudflareWorkersAI({
+ *   model: "@cf/meta/llama-2-7b-chat-int8",
+ *   cloudflareAccountId: process.env.CLOUDFLARE_ACCOUNT_ID,
+ *   cloudflareApiToken: process.env.CLOUDFLARE_API_TOKEN
+ * });
+ *
+ * const response = await model.invoke([
+ *   ["system", "You are a helpful assistant that translates English to German."],
+ *   ["human", `Translate "I love programming".`]
+ * ]);
+ *
+ * console.log(response);
+ * ```
  */
 export declare class ChatCloudflareWorkersAI extends SimpleChatModel implements CloudflareWorkersAIInput {
     static lc_name(): string;

package/dist/chat_models/cloudflare_workersai.js

@@ -6,6 +6,21 @@ import { convertEventStreamToIterableReadableDataStream } from "../util/event-so
  * A class that enables calls to the Cloudflare Workers AI API to access large language
  * models in a chat-like fashion. It extends the SimpleChatModel class and
  * implements the CloudflareWorkersAIInput interface.
+ * @example
+ * ```typescript
+ * const model = new ChatCloudflareWorkersAI({
+ *   model: "@cf/meta/llama-2-7b-chat-int8",
+ *   cloudflareAccountId: process.env.CLOUDFLARE_ACCOUNT_ID,
+ *   cloudflareApiToken: process.env.CLOUDFLARE_API_TOKEN
+ * });
+ *
+ * const response = await model.invoke([
+ *   ["system", "You are a helpful assistant that translates English to German."],
+ *   ["human", `Translate "I love programming".`]
+ * ]);
+ *
+ * console.log(response);
+ * ```
  */
 export class ChatCloudflareWorkersAI extends SimpleChatModel {
     static lc_name() {

package/dist/chat_models/fake.cjs

@@ -6,6 +6,22 @@ const index_js_1 = require("../schema/index.cjs");
 /**
  * A fake Chat Model that returns a predefined list of responses. It can be used
  * for testing purposes.
+ * @example
+ * ```typescript
+ * const chat = new FakeListChatModel({
+ *   responses: ["I'll callback later.", "You 'console' them!"]
+ * });
+ *
+ * const firstMessage = new HumanMessage("You want to hear a JavaScript joke?");
+ * const secondMessage = new HumanMessage("How do you cheer up a JavaScript developer?");
+ *
+ * // Call the chat model with a message and log the response
+ * const firstResponse = await chat.call([firstMessage]);
+ * console.log({ firstResponse });
+ *
+ * const secondResponse = await chat.call([secondMessage]);
+ * console.log({ secondResponse });
+ * ```
  */
 class FakeListChatModel extends base_js_1.BaseChatModel {
     static lc_name() {

package/dist/chat_models/fake.d.ts

@@ -13,6 +13,22 @@ export interface FakeChatInput extends BaseChatModelParams {
 /**
  * A fake Chat Model that returns a predefined list of responses. It can be used
  * for testing purposes.
+ * @example
+ * ```typescript
+ * const chat = new FakeListChatModel({
+ *   responses: ["I'll callback later.", "You 'console' them!"]
+ * });
+ *
+ * const firstMessage = new HumanMessage("You want to hear a JavaScript joke?");
+ * const secondMessage = new HumanMessage("How do you cheer up a JavaScript developer?");
+ *
+ * // Call the chat model with a message and log the response
+ * const firstResponse = await chat.call([firstMessage]);
+ * console.log({ firstResponse });
+ *
+ * const secondResponse = await chat.call([secondMessage]);
+ * console.log({ secondResponse });
+ * ```
  */
 export declare class FakeListChatModel extends BaseChatModel {
     static lc_name(): string;

package/dist/chat_models/fake.js

@@ -3,6 +3,22 @@ import { AIMessage, AIMessageChunk, ChatGenerationChunk, } from "../schema/index
 /**
  * A fake Chat Model that returns a predefined list of responses. It can be used
  * for testing purposes.
+ * @example
+ * ```typescript
+ * const chat = new FakeListChatModel({
+ *   responses: ["I'll callback later.", "You 'console' them!"]
+ * });
+ *
+ * const firstMessage = new HumanMessage("You want to hear a JavaScript joke?");
+ * const secondMessage = new HumanMessage("How do you cheer up a JavaScript developer?");
+ *
+ * // Call the chat model with a message and log the response
+ * const firstResponse = await chat.call([firstMessage]);
+ * console.log({ firstResponse });
+ *
+ * const secondResponse = await chat.call([secondMessage]);
+ * console.log({ secondResponse });
+ * ```
  */
 export class FakeListChatModel extends BaseChatModel {
     static lc_name() {

package/dist/chat_models/fireworks.cjs

@@ -11,6 +11,16 @@ const env_js_1 = require("../util/env.cjs");
  *
  * To use, you should have the `openai` package installed and
  * the `FIREWORKS_API_KEY` environment variable set.
+ * @example
+ * ```typescript
+ * const model = new ChatFireworks({
+ *   temperature: 0.9,
+ *   fireworksApiKey: "YOUR-API-KEY",
+ * });
+ *
+ * const response = await model.invoke("Hello, how are you?");
+ * console.log(response);
+ * ```
  */
 class ChatFireworks extends openai_js_1.ChatOpenAI {
     static lc_name() {

package/dist/chat_models/fireworks.d.ts

@@ -14,6 +14,16 @@ export type ChatFireworksCallOptions = Partial<Omit<ChatOpenAICallOptions, Firew
  *
  * To use, you should have the `openai` package installed and
  * the `FIREWORKS_API_KEY` environment variable set.
+ * @example
+ * ```typescript
+ * const model = new ChatFireworks({
+ *   temperature: 0.9,
+ *   fireworksApiKey: "YOUR-API-KEY",
+ * });
+ *
+ * const response = await model.invoke("Hello, how are you?");
+ * console.log(response);
+ * ```
  */
 export declare class ChatFireworks extends ChatOpenAI<ChatFireworksCallOptions> {
     static lc_name(): string;

package/dist/chat_models/fireworks.js

@@ -8,6 +8,16 @@ import { getEnvironmentVariable } from "../util/env.js";
  *
  * To use, you should have the `openai` package installed and
  * the `FIREWORKS_API_KEY` environment variable set.
+ * @example
+ * ```typescript
+ * const model = new ChatFireworks({
+ *   temperature: 0.9,
+ *   fireworksApiKey: "YOUR-API-KEY",
+ * });
+ *
+ * const response = await model.invoke("Hello, how are you?");
+ * console.log(response);
+ * ```
  */
 export class ChatFireworks extends ChatOpenAI {
     static lc_name() {

package/dist/chat_models/googlepalm.cjs

@@ -15,6 +15,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 });
+ * ```
  */
 class ChatGooglePaLM extends base_js_1.BaseChatModel {
     static lc_name() {