langchain 0.0.191 → 0.0.193

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 ?? {});

package/dist/document_loaders/fs/directory.cjs

@@ -13,6 +13,20 @@ exports.UnknownHandling = {
 /**
  * A document loader that loads documents from a directory. It extends the
  * `BaseDocumentLoader` class and implements the `load()` method.
+ * @example
+ * ```typescript
+ *
+ * const directoryLoader = new DirectoryLoader(
+ *   "src/document_loaders/example_data/",
+ *   {
+ *     ".pdf": (path: string) => new PDFLoader(path),
+ *   },
+ * );
+ *
+ * const docs = await directoryLoader.load();
+ * console.log({ docs });
+ *
+ * ```
  */
 class DirectoryLoader extends base_js_1.BaseDocumentLoader {
     constructor(directoryPath, loaders, recursive = true, unknown = exports.UnknownHandling.Warn) {

package/dist/document_loaders/fs/directory.d.ts

@@ -24,6 +24,20 @@ export interface LoadersMapping {
 /**
  * A document loader that loads documents from a directory. It extends the
  * `BaseDocumentLoader` class and implements the `load()` method.
+ * @example
+ * ```typescript
+ *
+ * const directoryLoader = new DirectoryLoader(
+ *   "src/document_loaders/example_data/",
+ *   {
+ *     ".pdf": (path: string) => new PDFLoader(path),
+ *   },
+ * );
+ *
+ * const docs = await directoryLoader.load();
+ * console.log({ docs });
+ *
+ * ```
  */
 export declare class DirectoryLoader extends BaseDocumentLoader {
     directoryPath: string;

package/dist/document_loaders/fs/directory.js

@@ -10,6 +10,20 @@ export const UnknownHandling = {
 /**
  * A document loader that loads documents from a directory. It extends the
  * `BaseDocumentLoader` class and implements the `load()` method.
+ * @example
+ * ```typescript
+ *
+ * const directoryLoader = new DirectoryLoader(
+ *   "src/document_loaders/example_data/",
+ *   {
+ *     ".pdf": (path: string) => new PDFLoader(path),
+ *   },
+ * );
+ *
+ * const docs = await directoryLoader.load();
+ * console.log({ docs });
+ *
+ * ```
  */
 export class DirectoryLoader extends BaseDocumentLoader {
     constructor(directoryPath, loaders, recursive = true, unknown = UnknownHandling.Warn) {

package/dist/document_loaders/fs/openai_whisper_audio.cjs

@@ -5,6 +5,16 @@ const openai_1 = require("openai");
 const document_js_1 = require("../../document.cjs");
 const buffer_js_1 = require("./buffer.cjs");
 const MODEL_NAME = "whisper-1";
+/**
+ * @example
+ * ```typescript
+ * const loader = new OpenAIWhisperAudio(
+ *   "./src/document_loaders/example_data/test.mp3",
+ * );
+ * const docs = await loader.load();
+ * console.log(docs);
+ * ```
+ */
 class OpenAIWhisperAudio extends buffer_js_1.BufferLoader {
     constructor(filePathOrBlob, fields) {
         super(filePathOrBlob);

package/dist/document_loaders/fs/openai_whisper_audio.d.ts

@@ -2,6 +2,16 @@
 import { type ClientOptions } from "openai";
 import { Document } from "../../document.js";
 import { BufferLoader } from "./buffer.js";
+/**
+ * @example
+ * ```typescript
+ * const loader = new OpenAIWhisperAudio(
+ *   "./src/document_loaders/example_data/test.mp3",
+ * );
+ * const docs = await loader.load();
+ * console.log(docs);
+ * ```
+ */
 export declare class OpenAIWhisperAudio extends BufferLoader {
     private readonly openAIClient;
     constructor(filePathOrBlob: string | Blob, fields?: {

package/dist/document_loaders/fs/openai_whisper_audio.js

@@ -2,6 +2,16 @@ import { OpenAI as OpenAIClient, toFile } from "openai";
 import { Document } from "../../document.js";
 import { BufferLoader } from "./buffer.js";
 const MODEL_NAME = "whisper-1";
+/**
+ * @example
+ * ```typescript
+ * const loader = new OpenAIWhisperAudio(
+ *   "./src/document_loaders/example_data/test.mp3",
+ * );
+ * const docs = await loader.load();
+ * console.log(docs);
+ * ```
+ */
 export class OpenAIWhisperAudio extends BufferLoader {
     constructor(filePathOrBlob, fields) {
         super(filePathOrBlob);

package/dist/document_loaders/fs/pdf.cjs

@@ -7,9 +7,15 @@ const document_js_2 = require("../../util/document.cjs");
 /**
  * A class that extends the `BufferLoader` class. It represents a document
  * loader that loads documents from PDF files.
+ * @example
+ * ```typescript
+ * const loader = new PDFLoader("path/to/bitcoin.pdf");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 class PDFLoader extends buffer_js_1.BufferLoader {
-    constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
+    constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {
         super(filePathOrBlob);
         Object.defineProperty(this, "splitPages", {
             enumerable: true,
@@ -23,8 +29,15 @@ class PDFLoader extends buffer_js_1.BufferLoader {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "parsedItemSeparator", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.splitPages = splitPages;
         this.pdfjs = pdfjs;
+        this.parsedItemSeparator = parsedItemSeparator;
     }
     /**
      * A method that takes a `raw` buffer and `metadata` as parameters and
@@ -75,7 +88,7 @@ class PDFLoader extends buffer_js_1.BufferLoader {
                     lastY = item.transform[5];
                 }
             }
-            const text = textItems.join(" ");
+            const text = textItems.join(this.parsedItemSeparator);
             documents.push(new document_js_1.Document({
                 pageContent: text,
                 metadata: {

package/dist/document_loaders/fs/pdf.d.ts

@@ -5,13 +5,21 @@ import { BufferLoader } from "./buffer.js";
 /**
  * A class that extends the `BufferLoader` class. It represents a document
  * loader that loads documents from PDF files.
+ * @example
+ * ```typescript
+ * const loader = new PDFLoader("path/to/bitcoin.pdf");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export declare class PDFLoader extends BufferLoader {
     private splitPages;
     private pdfjs;
-    constructor(filePathOrBlob: string | Blob, { splitPages, pdfjs }?: {
+    protected parsedItemSeparator: string;
+    constructor(filePathOrBlob: string | Blob, { splitPages, pdfjs, parsedItemSeparator, }?: {
         splitPages?: boolean | undefined;
         pdfjs?: typeof PDFLoaderImports | undefined;
+        parsedItemSeparator?: string | undefined;
     });
     /**
      * A method that takes a `raw` buffer and `metadata` as parameters and

package/dist/document_loaders/fs/pdf.js

@@ -4,9 +4,15 @@ import { formatDocumentsAsString } from "../../util/document.js";
 /**
  * A class that extends the `BufferLoader` class. It represents a document
  * loader that loads documents from PDF files.
+ * @example
+ * ```typescript
+ * const loader = new PDFLoader("path/to/bitcoin.pdf");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export class PDFLoader extends BufferLoader {
-    constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports } = {}) {
+    constructor(filePathOrBlob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {
         super(filePathOrBlob);
         Object.defineProperty(this, "splitPages", {
             enumerable: true,
@@ -20,8 +26,15 @@ export class PDFLoader extends BufferLoader {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "parsedItemSeparator", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         this.splitPages = splitPages;
         this.pdfjs = pdfjs;
+        this.parsedItemSeparator = parsedItemSeparator;
     }
     /**
      * A method that takes a `raw` buffer and `metadata` as parameters and
@@ -72,7 +85,7 @@ export class PDFLoader extends BufferLoader {
                     lastY = item.transform[5];
                 }
             }
-            const text = textItems.join(" ");
+            const text = textItems.join(this.parsedItemSeparator);
             documents.push(new Document({
                 pageContent: text,
                 metadata: {

package/dist/document_loaders/fs/srt.cjs

@@ -9,6 +9,12 @@ const text_js_1 = require("./text.cjs");
  * path to the SRT file or a `Blob` object. The `parse()` method is
  * implemented to parse the SRT file and extract the text content of each
  * subtitle.
+ * @example
+ * ```typescript
+ * const loader = new SRTLoader("path/to/file.srt");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 class SRTLoader extends text_js_1.TextLoader {
     constructor(filePathOrBlob) {

package/dist/document_loaders/fs/srt.d.ts

@@ -6,6 +6,12 @@ import { TextLoader } from "./text.js";
  * path to the SRT file or a `Blob` object. The `parse()` method is
  * implemented to parse the SRT file and extract the text content of each
  * subtitle.
+ * @example
+ * ```typescript
+ * const loader = new SRTLoader("path/to/file.srt");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export declare class SRTLoader extends TextLoader {
     constructor(filePathOrBlob: string | Blob);

package/dist/document_loaders/fs/srt.js

@@ -6,6 +6,12 @@ import { TextLoader } from "./text.js";
  * path to the SRT file or a `Blob` object. The `parse()` method is
  * implemented to parse the SRT file and extract the text content of each
  * subtitle.
+ * @example
+ * ```typescript
+ * const loader = new SRTLoader("path/to/file.srt");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export class SRTLoader extends TextLoader {
     constructor(filePathOrBlob) {

package/dist/document_loaders/fs/text.cjs

@@ -11,6 +11,11 @@ const base_js_1 = require("../base.cjs");
  * using the `parse()` method, and create a `Document` instance for each
  * parsed page. The metadata includes the source of the text (file path or
  * blob) and, if there are multiple pages, the line number of each page.
+ * @example
+ * ```typescript
+ * const loader = new TextLoader("src/document_loaders/example_data/example.txt");
+ * const docs = await loader.load();
+ * ```
  */
 class TextLoader extends base_js_1.BaseDocumentLoader {
     constructor(filePathOrBlob) {

package/dist/document_loaders/fs/text.d.ts

@@ -9,6 +9,11 @@ import { BaseDocumentLoader } from "../base.js";
  * using the `parse()` method, and create a `Document` instance for each
  * parsed page. The metadata includes the source of the text (file path or
  * blob) and, if there are multiple pages, the line number of each page.
+ * @example
+ * ```typescript
+ * const loader = new TextLoader("src/document_loaders/example_data/example.txt");
+ * const docs = await loader.load();
+ * ```
  */
 export declare class TextLoader extends BaseDocumentLoader {
     filePathOrBlob: string | Blob;

package/dist/document_loaders/fs/text.js

@@ -8,6 +8,11 @@ import { BaseDocumentLoader } from "../base.js";
  * using the `parse()` method, and create a `Document` instance for each
  * parsed page. The metadata includes the source of the text (file path or
  * blob) and, if there are multiple pages, the line number of each page.
+ * @example
+ * ```typescript
+ * const loader = new TextLoader("src/document_loaders/example_data/example.txt");
+ * const docs = await loader.load();
+ * ```
  */
 export class TextLoader extends BaseDocumentLoader {
     constructor(filePathOrBlob) {

package/dist/document_loaders/fs/unstructured.cjs

@@ -229,6 +229,13 @@ exports.UnstructuredLoader = UnstructuredLoader;
  * using the UnstructuredLoader. It creates a UnstructuredLoader instance
  * for each supported file type and passes it to the DirectoryLoader
  * constructor.
+ * @example
+ * ```typescript
+ * const loader = new UnstructuredDirectoryLoader("path/to/directory", {
+ *   apiKey: "MY_API_KEY",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class UnstructuredDirectoryLoader extends directory_js_1.DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl, optionsOrLegacyDirectoryPath, legacyOptionRecursive = true, legacyOptionUnknown = directory_js_1.UnknownHandling.Warn) {

package/dist/document_loaders/fs/unstructured.d.ts

@@ -94,6 +94,13 @@ export declare class UnstructuredLoader extends BaseDocumentLoader {
  * using the UnstructuredLoader. It creates a UnstructuredLoader instance
  * for each supported file type and passes it to the DirectoryLoader
  * constructor.
+ * @example
+ * ```typescript
+ * const loader = new UnstructuredDirectoryLoader("path/to/directory", {
+ *   apiKey: "MY_API_KEY",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class UnstructuredDirectoryLoader extends DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl: string, optionsOrLegacyDirectoryPath: UnstructuredDirectoryLoaderOptions | string, legacyOptionRecursive?: boolean, legacyOptionUnknown?: UnknownHandling);

package/dist/document_loaders/fs/unstructured.js

@@ -224,6 +224,13 @@ export class UnstructuredLoader extends BaseDocumentLoader {
  * using the UnstructuredLoader. It creates a UnstructuredLoader instance
  * for each supported file type and passes it to the DirectoryLoader
  * constructor.
+ * @example
+ * ```typescript
+ * const loader = new UnstructuredDirectoryLoader("path/to/directory", {
+ *   apiKey: "MY_API_KEY",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class UnstructuredDirectoryLoader extends DirectoryLoader {
     constructor(directoryPathOrLegacyApiUrl, optionsOrLegacyDirectoryPath, legacyOptionRecursive = true, legacyOptionUnknown = UnknownHandling.Warn) {

package/dist/document_loaders/web/apify_dataset.cjs

@@ -10,6 +10,27 @@ const env_js_1 = require("../../util/env.cjs");
  * A class that extends the BaseDocumentLoader and implements the
  * DocumentLoader interface. It represents a document loader that loads
  * documents from an Apify dataset.
+ * @example
+ * ```typescript
+ * const loader = new ApifyDatasetLoader("your-dataset-id", {
+ *   datasetMappingFunction: (item) =>
+ *     new Document({
+ *       pageContent: item.text || "",
+ *       metadata: { source: item.url },
+ *     }),
+ *   clientOptions: {
+ *     token: "your-apify-token",
+ *   },
+ * });
+ *
+ * const docs = await loader.load();
+ *
+ * const chain = new RetrievalQAChain();
+ * const res = await chain.invoke({ query: "What is LangChain?" });
+ *
+ * console.log(res.text);
+ * console.log(res.sourceDocuments.map((d) => d.metadata.source));
+ * ```
  */
 class ApifyDatasetLoader extends base_js_1.BaseDocumentLoader {
     constructor(datasetId, config) {
@@ -55,8 +76,11 @@ class ApifyDatasetLoader extends base_js_1.BaseDocumentLoader {
      * @returns An array of Document instances.
      */
     async load() {
-        const datasetItems = (await this.apifyClient.dataset(this.datasetId).listItems({ clean: true })).items;
-        return await Promise.all(datasetItems.map((item) => this.caller.call(async () => this.datasetMappingFunction(item))));
+        const dataset = await this.apifyClient
+            .dataset(this.datasetId)
+            .listItems({ clean: true });
+        const documentList = await Promise.all(dataset.items.map((item) => this.caller.call(async () => this.datasetMappingFunction(item))));
+        return documentList.flat();
     }
     /**
      * Create an ApifyDatasetLoader by calling an Actor on the Apify platform and waiting for its results to be ready.

package/dist/document_loaders/web/apify_dataset.d.ts

@@ -5,8 +5,11 @@ import { Document } from "../../document.js";
 /**
  * A type that represents a function that takes a single object (an Apify
  * dataset item) and converts it to an instance of the Document class.
+ *
+ * Change function signature to only be asynchronous for simplicity in v0.1.0
+ * https://github.com/langchain-ai/langchainjs/pull/3262
  */
-export type ApifyDatasetMappingFunction<Metadata extends Record<string, any>> = (item: Record<string | number, unknown>) => Document<Metadata> | Promise<Document<Metadata>>;
+export type ApifyDatasetMappingFunction<Metadata extends Record<string, any>> = (item: Record<string | number, unknown>) => Document<Metadata> | Array<Document<Metadata>> | Promise<Document<Metadata> | Array<Document<Metadata>>>;
 export interface ApifyDatasetLoaderConfig<Metadata extends Record<string, any>> extends AsyncCallerParams {
     datasetMappingFunction: ApifyDatasetMappingFunction<Metadata>;
     clientOptions?: ApifyClientOptions;
@@ -15,6 +18,27 @@ export interface ApifyDatasetLoaderConfig<Metadata extends Record<string, any>>
  * A class that extends the BaseDocumentLoader and implements the
  * DocumentLoader interface. It represents a document loader that loads
  * documents from an Apify dataset.
+ * @example
+ * ```typescript
+ * const loader = new ApifyDatasetLoader("your-dataset-id", {
+ *   datasetMappingFunction: (item) =>
+ *     new Document({
+ *       pageContent: item.text || "",
+ *       metadata: { source: item.url },
+ *     }),
+ *   clientOptions: {
+ *     token: "your-apify-token",
+ *   },
+ * });
+ *
+ * const docs = await loader.load();
+ *
+ * const chain = new RetrievalQAChain();
+ * const res = await chain.invoke({ query: "What is LangChain?" });
+ *
+ * console.log(res.text);
+ * console.log(res.sourceDocuments.map((d) => d.metadata.source));
+ * ```
  */
 export declare class ApifyDatasetLoader<Metadata extends Record<string, any>> extends BaseDocumentLoader implements DocumentLoader {
     protected apifyClient: ApifyClient;