langchain 0.0.192 → 0.0.194

package/dist/stores/message/planetscale.js

@@ -4,6 +4,24 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
 /**
  * Class for storing and retrieving chat message history from a
  * PlanetScale database. Extends the BaseListChatMessageHistory class.
+ * @example
+ * ```typescript
+ * const chatHistory = new PlanetScaleChatMessageHistory({
+ *   tableName: "stored_message",
+ *   sessionId: "lc-example",
+ *   config: {
+ *     url: "ADD_YOURS_HERE",
+ *   },
+ * });
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI(),
+ *   memory: chatHistory,
+ * });
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 export class PlanetScaleChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {

package/dist/stores/message/redis.cjs

@@ -8,6 +8,24 @@ const utils_js_1 = require("./utils.cjs");
 /**
  * Class for storing chat message history using Redis. Extends the
  * `BaseListChatMessageHistory` class.
+ * @example
+ * ```typescript
+ * const chatHistory = new RedisChatMessageHistory({
+ *   sessionId: new Date().toISOString(),
+ *   sessionTTL: 300,
+ *   url: "redis:
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI({ modelName: "gpt-3.5-turbo", temperature: 0 }),
+ *   memory: { chatHistory },
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 class RedisChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     get lc_secrets() {

package/dist/stores/message/redis.d.ts

@@ -12,6 +12,24 @@ export type RedisChatMessageHistoryInput = {
 /**
  * Class for storing chat message history using Redis. Extends the
  * `BaseListChatMessageHistory` class.
+ * @example
+ * ```typescript
+ * const chatHistory = new RedisChatMessageHistory({
+ *   sessionId: new Date().toISOString(),
+ *   sessionTTL: 300,
+ *   url: "redis:
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI({ modelName: "gpt-3.5-turbo", temperature: 0 }),
+ *   memory: { chatHistory },
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 export declare class RedisChatMessageHistory extends BaseListChatMessageHistory {
     lc_namespace: string[];

package/dist/stores/message/redis.js

@@ -5,6 +5,24 @@ import { mapChatMessagesToStoredMessages, mapStoredMessagesToChatMessages, } fro
 /**
  * Class for storing chat message history using Redis. Extends the
  * `BaseListChatMessageHistory` class.
+ * @example
+ * ```typescript
+ * const chatHistory = new RedisChatMessageHistory({
+ *   sessionId: new Date().toISOString(),
+ *   sessionTTL: 300,
+ *   url: "redis:
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI({ modelName: "gpt-3.5-turbo", temperature: 0 }),
+ *   memory: { chatHistory },
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 export class RedisChatMessageHistory extends BaseListChatMessageHistory {
     get lc_secrets() {

package/dist/stores/message/xata.cjs

@@ -17,6 +17,29 @@ const chatMemoryColumns = [
  * extends the BaseListChatMessageHistory class and provides methods to
  * get, add, and clear messages. It also ensures the existence of a table
  * where the chat messages are stored.
+ * @example
+ * ```typescript
+ * const chatHistory = new XataChatMessageHistory({
+ *   table: "messages",
+ *   sessionId: new Date().toISOString(),
+ *   client: new BaseClient({
+ *     databaseURL: process.env.XATA_DB_URL,
+ *     apiKey: process.env.XATA_API_KEY,
+ *     branch: "main",
+ *   }),
+ *   apiKey: process.env.XATA_API_KEY,
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI(),
+ *   memory: new BufferMemory({ chatHistory }),
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 class XataChatMessageHistory extends index_js_1.BaseListChatMessageHistory {
     constructor(fields) {

package/dist/stores/message/xata.d.ts

@@ -17,6 +17,29 @@ export type XataChatMessageHistoryInput<XataClient> = {
  * extends the BaseListChatMessageHistory class and provides methods to
  * get, add, and clear messages. It also ensures the existence of a table
  * where the chat messages are stored.
+ * @example
+ * ```typescript
+ * const chatHistory = new XataChatMessageHistory({
+ *   table: "messages",
+ *   sessionId: new Date().toISOString(),
+ *   client: new BaseClient({
+ *     databaseURL: process.env.XATA_DB_URL,
+ *     apiKey: process.env.XATA_API_KEY,
+ *     branch: "main",
+ *   }),
+ *   apiKey: process.env.XATA_API_KEY,
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI(),
+ *   memory: new BufferMemory({ chatHistory }),
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 export declare class XataChatMessageHistory<XataClient extends BaseClient> extends BaseListChatMessageHistory {
     lc_namespace: string[];

package/dist/stores/message/xata.js

@@ -14,6 +14,29 @@ const chatMemoryColumns = [
  * extends the BaseListChatMessageHistory class and provides methods to
  * get, add, and clear messages. It also ensures the existence of a table
  * where the chat messages are stored.
+ * @example
+ * ```typescript
+ * const chatHistory = new XataChatMessageHistory({
+ *   table: "messages",
+ *   sessionId: new Date().toISOString(),
+ *   client: new BaseClient({
+ *     databaseURL: process.env.XATA_DB_URL,
+ *     apiKey: process.env.XATA_API_KEY,
+ *     branch: "main",
+ *   }),
+ *   apiKey: process.env.XATA_API_KEY,
+ * });
+ *
+ * const chain = new ConversationChain({
+ *   llm: new ChatOpenAI(),
+ *   memory: new BufferMemory({ chatHistory }),
+ * });
+ *
+ * const response = await chain.invoke({
+ *   input: "What did I just say my name was?",
+ * });
+ * console.log({ response });
+ * ```
  */
 export class XataChatMessageHistory extends BaseListChatMessageHistory {
     constructor(fields) {

package/dist/tools/calculator.cjs

@@ -6,6 +6,12 @@ const base_js_1 = require("./base.cjs");
 /**
  * The Calculator class is a tool used to evaluate mathematical
  * expressions. It extends the base Tool class.
+ * @example
+ * ```typescript
+ * const calculator = new Calculator();
+ * const sum = calculator.add(99, 99);
+ * console.log("The sum of 99 and 99 is:", sum);
+ * ```
  */
 class Calculator extends base_js_1.Tool {
     constructor() {

package/dist/tools/calculator.d.ts

@@ -2,6 +2,12 @@ import { Tool } from "./base.js";
 /**
  * The Calculator class is a tool used to evaluate mathematical
  * expressions. It extends the base Tool class.
+ * @example
+ * ```typescript
+ * const calculator = new Calculator();
+ * const sum = calculator.add(99, 99);
+ * console.log("The sum of 99 and 99 is:", sum);
+ * ```
  */
 export declare class Calculator extends Tool {
     static lc_name(): string;

package/dist/tools/calculator.js

@@ -3,6 +3,12 @@ import { Tool } from "./base.js";
 /**
  * The Calculator class is a tool used to evaluate mathematical
  * expressions. It extends the base Tool class.
+ * @example
+ * ```typescript
+ * const calculator = new Calculator();
+ * const sum = calculator.add(99, 99);
+ * console.log("The sum of 99 and 99 is:", sum);
+ * ```
  */
 export class Calculator extends Tool {
     constructor() {

package/dist/tools/google_calendar/create.cjs

@@ -4,6 +4,28 @@ exports.GoogleCalendarCreateTool = void 0;
 const base_js_1 = require("./base.cjs");
 const run_create_events_js_1 = require("./commands/run-create-events.cjs");
 const descriptions_js_1 = require("./descriptions.cjs");
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarCreateTool = new GoogleCalendarCreateTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const createInput = `Create a meeting with John Doe next Friday at 4pm - adding to the agenda of it the result of 99 + 99`;
+ * const createResult = await googleCalendarCreateTool.invoke({
+ *   input: createInput,
+ * });
+ * console.log("Create Result", createResult);
+ * ```
+ */
 class GoogleCalendarCreateTool extends base_js_1.GoogleCalendarBase {
     constructor(fields) {
         super(fields);

package/dist/tools/google_calendar/create.d.ts

@@ -1,5 +1,27 @@
 import { CallbackManagerForToolRun } from "../../callbacks/manager.js";
 import { GoogleCalendarBase, GoogleCalendarAgentParams } from "./base.js";
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarCreateTool = new GoogleCalendarCreateTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const createInput = `Create a meeting with John Doe next Friday at 4pm - adding to the agenda of it the result of 99 + 99`;
+ * const createResult = await googleCalendarCreateTool.invoke({
+ *   input: createInput,
+ * });
+ * console.log("Create Result", createResult);
+ * ```
+ */
 export declare class GoogleCalendarCreateTool extends GoogleCalendarBase {
     name: string;
     description: string;

package/dist/tools/google_calendar/create.js

@@ -1,6 +1,28 @@
 import { GoogleCalendarBase } from "./base.js";
 import { runCreateEvent } from "./commands/run-create-events.js";
 import { CREATE_TOOL_DESCRIPTION } from "./descriptions.js";
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarCreateTool = new GoogleCalendarCreateTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const createInput = `Create a meeting with John Doe next Friday at 4pm - adding to the agenda of it the result of 99 + 99`;
+ * const createResult = await googleCalendarCreateTool.invoke({
+ *   input: createInput,
+ * });
+ * console.log("Create Result", createResult);
+ * ```
+ */
 export class GoogleCalendarCreateTool extends GoogleCalendarBase {
     constructor(fields) {
         super(fields);

package/dist/tools/google_calendar/view.cjs

@@ -4,6 +4,26 @@ exports.GoogleCalendarViewTool = void 0;
 const base_js_1 = require("./base.cjs");
 const descriptions_js_1 = require("./descriptions.cjs");
 const run_view_events_js_1 = require("./commands/run-view-events.cjs");
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarViewTool = new GoogleCalendarViewTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const viewInput = `What meetings do I have this week?`;
+ * const viewResult = await googleCalendarViewTool.invoke({ input: viewInput });
+ * console.log("View Result", viewResult);
+ * ```
+ */
 class GoogleCalendarViewTool extends base_js_1.GoogleCalendarBase {
     constructor(fields) {
         super(fields);

package/dist/tools/google_calendar/view.d.ts

@@ -1,5 +1,25 @@
 import { GoogleCalendarBase, GoogleCalendarAgentParams } from "./base.js";
 import { CallbackManagerForToolRun } from "../../callbacks/manager.js";
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarViewTool = new GoogleCalendarViewTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const viewInput = `What meetings do I have this week?`;
+ * const viewResult = await googleCalendarViewTool.invoke({ input: viewInput });
+ * console.log("View Result", viewResult);
+ * ```
+ */
 export declare class GoogleCalendarViewTool extends GoogleCalendarBase {
     name: string;
     description: string;

package/dist/tools/google_calendar/view.js

@@ -1,6 +1,26 @@
 import { GoogleCalendarBase } from "./base.js";
 import { VIEW_TOOL_DESCRIPTION } from "./descriptions.js";
 import { runViewEvents } from "./commands/run-view-events.js";
+/**
+ * @example
+ * ```typescript
+ * const googleCalendarViewTool = new GoogleCalendarViewTool({
+ *   credentials: {
+ *     clientEmail: process.env.GOOGLE_CALENDAR_CLIENT_EMAIL,
+ *     privateKey: process.env.GOOGLE_CALENDAR_PRIVATE_KEY,
+ *     calendarId: process.env.GOOGLE_CALENDAR_CALENDAR_ID,
+ *   },
+ *   scopes: [
+ *     "https:
+ *     "https:
+ *   ],
+ *   model: new ChatOpenAI({}),
+ * });
+ * const viewInput = `What meetings do I have this week?`;
+ * const viewResult = await googleCalendarViewTool.invoke({ input: viewInput });
+ * console.log("View Result", viewResult);
+ * ```
+ */
 export class GoogleCalendarViewTool extends GoogleCalendarBase {
     constructor(fields) {
         super(fields);

package/dist/tools/searchapi.cjs

@@ -13,6 +13,33 @@ function isJSONObject(value) {
  *
  * Ensure you've set the SEARCHAPI_API_KEY environment variable for authentication.
  * You can obtain a free API key from https://www.searchapi.io/.
+ * @example
+ * ```typescript
+ * const searchApi = new SearchApi("your-api-key", {
+ *   engine: "google_news",
+ * });
+ * const agent = RunnableSequence.from([
+ *   ChatPromptTemplate.fromMessages([
+ *     ["ai", "Answer the following questions using a bulleted list markdown format.""],
+ *     ["human", "{input}"],
+ *   ]),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   (input: BaseMessageChunk) => ({
+ *     log: "test",
+ *     returnValues: {
+ *       output: input,
+ *     },
+ *   }),
+ * ]);
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [searchApi],
+ * });
+ * const res = await executor.invoke({
+ *   input: "What's happening in Ukraine today?"",
+ * });
+ * console.log(res);
+ * ```
  */
 class SearchApi extends base_js_1.Tool {
     static lc_name() {

package/dist/tools/searchapi.d.ts

@@ -27,6 +27,33 @@ export type SearchApiParameters = {
  *
  * Ensure you've set the SEARCHAPI_API_KEY environment variable for authentication.
  * You can obtain a free API key from https://www.searchapi.io/.
+ * @example
+ * ```typescript
+ * const searchApi = new SearchApi("your-api-key", {
+ *   engine: "google_news",
+ * });
+ * const agent = RunnableSequence.from([
+ *   ChatPromptTemplate.fromMessages([
+ *     ["ai", "Answer the following questions using a bulleted list markdown format.""],
+ *     ["human", "{input}"],
+ *   ]),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   (input: BaseMessageChunk) => ({
+ *     log: "test",
+ *     returnValues: {
+ *       output: input,
+ *     },
+ *   }),
+ * ]);
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [searchApi],
+ * });
+ * const res = await executor.invoke({
+ *   input: "What's happening in Ukraine today?"",
+ * });
+ * console.log(res);
+ * ```
  */
 export declare class SearchApi extends Tool {
     static lc_name(): string;

package/dist/tools/searchapi.js

@@ -10,6 +10,33 @@ function isJSONObject(value) {
  *
  * Ensure you've set the SEARCHAPI_API_KEY environment variable for authentication.
  * You can obtain a free API key from https://www.searchapi.io/.
+ * @example
+ * ```typescript
+ * const searchApi = new SearchApi("your-api-key", {
+ *   engine: "google_news",
+ * });
+ * const agent = RunnableSequence.from([
+ *   ChatPromptTemplate.fromMessages([
+ *     ["ai", "Answer the following questions using a bulleted list markdown format.""],
+ *     ["human", "{input}"],
+ *   ]),
+ *   new ChatOpenAI({ temperature: 0 }),
+ *   (input: BaseMessageChunk) => ({
+ *     log: "test",
+ *     returnValues: {
+ *       output: input,
+ *     },
+ *   }),
+ * ]);
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [searchApi],
+ * });
+ * const res = await executor.invoke({
+ *   input: "What's happening in Ukraine today?"",
+ * });
+ * console.log(res);
+ * ```
  */
 export class SearchApi extends Tool {
     static lc_name() {

package/dist/tools/searxng_search.cjs

@@ -9,7 +9,26 @@ const base_js_1 = require("./base.cjs");
  * The input should be a search query, and the output is a JSON array of the query results.
  *
  * note: works best with *agentType*: `structured-chat-zero-shot-react-description`
- * https://github.com/searxng/searxng */
+ * https://github.com/searxng/searxng
+ * @example
+ * ```typescript
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [
+ *     new SearxngSearch({
+ *       params: {
+ *         format: "json",
+ *         engines: "google",
+ *       },
+ *       headers: {},
+ *     }),
+ *   ],
+ * });
+ * const result = await executor.invoke({
+ *   input: `What is Langchain? Describe in 50 words`,
+ * });
+ * ```
+ */
 class SearxngSearch extends base_js_1.Tool {
     static lc_name() {
         return "SearxngSearch";

package/dist/tools/searxng_search.d.ts

@@ -50,7 +50,26 @@ interface SearxngSearchParams {
  * The input should be a search query, and the output is a JSON array of the query results.
  *
  * note: works best with *agentType*: `structured-chat-zero-shot-react-description`
- * https://github.com/searxng/searxng */
+ * https://github.com/searxng/searxng
+ * @example
+ * ```typescript
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [
+ *     new SearxngSearch({
+ *       params: {
+ *         format: "json",
+ *         engines: "google",
+ *       },
+ *       headers: {},
+ *     }),
+ *   ],
+ * });
+ * const result = await executor.invoke({
+ *   input: `What is Langchain? Describe in 50 words`,
+ * });
+ * ```
+ */
 export declare class SearxngSearch extends Tool {
     static lc_name(): string;
     name: string;

package/dist/tools/searxng_search.js

@@ -6,7 +6,26 @@ import { Tool } from "./base.js";
  * The input should be a search query, and the output is a JSON array of the query results.
  *
  * note: works best with *agentType*: `structured-chat-zero-shot-react-description`
- * https://github.com/searxng/searxng */
+ * https://github.com/searxng/searxng
+ * @example
+ * ```typescript
+ * const executor = AgentExecutor.fromAgentAndTools({
+ *   agent,
+ *   tools: [
+ *     new SearxngSearch({
+ *       params: {
+ *         format: "json",
+ *         engines: "google",
+ *       },
+ *       headers: {},
+ *     }),
+ *   ],
+ * });
+ * const result = await executor.invoke({
+ *   input: `What is Langchain? Describe in 50 words`,
+ * });
+ * ```
+ */
 export class SearxngSearch extends Tool {
     static lc_name() {
         return "SearxngSearch";

package/dist/tools/webbrowser.cjs

@@ -139,6 +139,14 @@ const DEFAULT_HEADERS = {
  * information from them or to summarize their content. It uses the axios
  * library to send HTTP requests and the cheerio library to parse the
  * returned HTML.
+ * @example
+ * ```typescript
+ * const browser = new WebBrowser({
+ *   model: new ChatOpenAI({ temperature: 0 }),
+ *   embeddings: new OpenAIEmbeddings({}),
+ * });
+ * const result = await browser.invoke("https:exampleurl.com");
+ * ```
  */
 class WebBrowser extends base_js_1.Tool {
     static lc_name() {

package/dist/tools/webbrowser.d.ts

@@ -27,6 +27,14 @@ export interface WebBrowserArgs extends ToolParams {
  * information from them or to summarize their content. It uses the axios
  * library to send HTTP requests and the cheerio library to parse the
  * returned HTML.
+ * @example
+ * ```typescript
+ * const browser = new WebBrowser({
+ *   model: new ChatOpenAI({ temperature: 0 }),
+ *   embeddings: new OpenAIEmbeddings({}),
+ * });
+ * const result = await browser.invoke("https:exampleurl.com");
+ * ```
  */
 export declare class WebBrowser extends Tool {
     static lc_name(): string;

package/dist/tools/webbrowser.js

@@ -108,6 +108,14 @@ const DEFAULT_HEADERS = {
  * information from them or to summarize their content. It uses the axios
  * library to send HTTP requests and the cheerio library to parse the
  * returned HTML.
+ * @example
+ * ```typescript
+ * const browser = new WebBrowser({
+ *   model: new ChatOpenAI({ temperature: 0 }),
+ *   embeddings: new OpenAIEmbeddings({}),
+ * });
+ * const result = await browser.invoke("https:exampleurl.com");
+ * ```
  */
 export class WebBrowser extends Tool {
     static lc_name() {

package/dist/tools/wikipedia_query_run.cjs

@@ -5,6 +5,14 @@ const base_js_1 = require("./base.cjs");
 /**
  * Class for interacting with and fetching data from the Wikipedia API. It
  * extends the Tool class.
+ * @example
+ * ```typescript
+ * const wikipediaQuery = new WikipediaQueryRun({
+ *   topKResults: 3,
+ *   maxDocContentLength: 4000,
+ * });
+ * const result = await wikipediaQuery.call("Langchain");
+ * ```
  */
 class WikipediaQueryRun extends base_js_1.Tool {
     static lc_name() {

package/dist/tools/wikipedia_query_run.d.ts

@@ -16,6 +16,14 @@ type UrlParameters = Record<string, string | number | boolean | undefined | null
 /**
  * Class for interacting with and fetching data from the Wikipedia API. It
  * extends the Tool class.
+ * @example
+ * ```typescript
+ * const wikipediaQuery = new WikipediaQueryRun({
+ *   topKResults: 3,
+ *   maxDocContentLength: 4000,
+ * });
+ * const result = await wikipediaQuery.call("Langchain");
+ * ```
  */
 export declare class WikipediaQueryRun extends Tool {
     static lc_name(): string;