langchain 0.0.192 → 0.0.193

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,6 +7,12 @@ 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, parsedItemSeparator = " ", } = {}) {

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

@@ -5,6 +5,12 @@ 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;

package/dist/document_loaders/fs/pdf.js

@@ -4,6 +4,12 @@ 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, parsedItemSeparator = " ", } = {}) {

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) {

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

@@ -18,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;

package/dist/document_loaders/web/apify_dataset.js

@@ -7,6 +7,27 @@ import { getEnvironmentVariable } from "../../util/env.js";
  * 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 class ApifyDatasetLoader extends BaseDocumentLoader {
     constructor(datasetId, config) {

package/dist/document_loaders/web/assemblyai.cjs

@@ -74,6 +74,15 @@ class CreateTranscriptLoader extends AssemblyAILoader {
 }
 /**
  * Creates and loads the transcript as a document using AssemblyAI.
+ * @example
+ * ```typescript
+ * const loader = new AudioTranscriptLoader(
+ *   { audio_url: "https:
+ *   { apiKey: "ASSEMBLYAI_API_KEY" },
+ * );
+ * const docs = await loader.load();
+ * console.dir(docs, { depth: Infinity });
+ * ```
  */
 class AudioTranscriptLoader extends CreateTranscriptLoader {
     /**
@@ -131,6 +140,21 @@ class AudioTranscriptSentencesLoader extends CreateTranscriptLoader {
 exports.AudioTranscriptSentencesLoader = AudioTranscriptSentencesLoader;
 /**
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
+ * @example
+ * ```typescript
+ * const loader = new AudioSubtitleLoader(
+ *   {
+ *     audio_url: "https:
+ *   },
+ *   "srt",
+ *   {
+ *     apiKey: "<ASSEMBLYAI_API_KEY>",
+ *   },
+ * );
+ *
+ *
+ * const docs = await loader.load();
+ * ```
  */
 class AudioSubtitleLoader extends CreateTranscriptLoader {
     /**

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

@@ -29,6 +29,15 @@ declare abstract class CreateTranscriptLoader extends AssemblyAILoader {
 }
 /**
  * Creates and loads the transcript as a document using AssemblyAI.
+ * @example
+ * ```typescript
+ * const loader = new AudioTranscriptLoader(
+ *   { audio_url: "https:
+ *   { apiKey: "ASSEMBLYAI_API_KEY" },
+ * );
+ * const docs = await loader.load();
+ * console.dir(docs, { depth: Infinity });
+ * ```
  */
 export declare class AudioTranscriptLoader extends CreateTranscriptLoader {
     /**
@@ -61,6 +70,21 @@ export declare class AudioTranscriptSentencesLoader extends CreateTranscriptLoad
 }
 /**
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
+ * @example
+ * ```typescript
+ * const loader = new AudioSubtitleLoader(
+ *   {
+ *     audio_url: "https:
+ *   },
+ *   "srt",
+ *   {
+ *     apiKey: "<ASSEMBLYAI_API_KEY>",
+ *   },
+ * );
+ *
+ *
+ * const docs = await loader.load();
+ * ```
  */
 export declare class AudioSubtitleLoader extends CreateTranscriptLoader {
     private subtitleFormat;

package/dist/document_loaders/web/assemblyai.js

@@ -71,6 +71,15 @@ class CreateTranscriptLoader extends AssemblyAILoader {
 }
 /**
  * Creates and loads the transcript as a document using AssemblyAI.
+ * @example
+ * ```typescript
+ * const loader = new AudioTranscriptLoader(
+ *   { audio_url: "https:
+ *   { apiKey: "ASSEMBLYAI_API_KEY" },
+ * );
+ * const docs = await loader.load();
+ * console.dir(docs, { depth: Infinity });
+ * ```
  */
 export class AudioTranscriptLoader extends CreateTranscriptLoader {
     /**
@@ -125,6 +134,21 @@ export class AudioTranscriptSentencesLoader extends CreateTranscriptLoader {
 }
 /**
  * Creates a transcript and loads subtitles for the transcript as `srt` or `vtt` format.
+ * @example
+ * ```typescript
+ * const loader = new AudioSubtitleLoader(
+ *   {
+ *     audio_url: "https:
+ *   },
+ *   "srt",
+ *   {
+ *     apiKey: "<ASSEMBLYAI_API_KEY>",
+ *   },
+ * );
+ *
+ *
+ * const docs = await loader.load();
+ * ```
  */
 export class AudioSubtitleLoader extends CreateTranscriptLoader {
     /**

package/dist/document_loaders/web/azure_blob_storage_file.cjs

@@ -34,6 +34,17 @@ const unstructured_js_1 = require("../fs/unstructured.cjs");
  * Class representing a document loader that loads a specific file from
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
  * implements the DocumentLoader interface.
+ * @example
+ * ```typescript
+ * const loader = new AzureBlobStorageFileLoader({
+ *   azureConfig: {
+ *     connectionString: "{connectionString}",
+ *     container: "{containerName}",
+ *     blobName: "{blobName}",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class AzureBlobStorageFileLoader extends base_js_1.BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {

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

@@ -22,6 +22,17 @@ interface AzureBlobStorageFileLoaderConfig {
  * Class representing a document loader that loads a specific file from
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
  * implements the DocumentLoader interface.
+ * @example
+ * ```typescript
+ * const loader = new AzureBlobStorageFileLoader({
+ *   azureConfig: {
+ *     connectionString: "{connectionString}",
+ *     container: "{containerName}",
+ *     blobName: "{blobName}",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class AzureBlobStorageFileLoader extends BaseDocumentLoader {
     private readonly connectionString;

package/dist/document_loaders/web/azure_blob_storage_file.js

@@ -8,6 +8,17 @@ import { UnstructuredLoader, } from "../fs/unstructured.js";
  * Class representing a document loader that loads a specific file from
  * Azure Blob Storage. It extends the BaseDocumentLoader class and
  * implements the DocumentLoader interface.
+ * @example
+ * ```typescript
+ * const loader = new AzureBlobStorageFileLoader({
+ *   azureConfig: {
+ *     connectionString: "{connectionString}",
+ *     container: "{containerName}",
+ *     blobName: "{blobName}",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class AzureBlobStorageFileLoader extends BaseDocumentLoader {
     constructor({ azureConfig, unstructuredConfig, }) {

package/dist/document_loaders/web/cheerio.cjs

@@ -8,6 +8,12 @@ const async_caller_js_1 = require("../../util/async_caller.cjs");
  * A class that extends the BaseDocumentLoader and implements the
  * DocumentLoader interface. It represents a document loader for loading
  * web-based documents using Cheerio.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 class CheerioWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, fields) {

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

@@ -27,6 +27,12 @@ export interface WebBaseLoaderParams extends AsyncCallerParams {
  * A class that extends the BaseDocumentLoader and implements the
  * DocumentLoader interface. It represents a document loader for loading
  * web-based documents using Cheerio.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export declare class CheerioWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;

package/dist/document_loaders/web/cheerio.js

@@ -5,6 +5,12 @@ import { AsyncCaller } from "../../util/async_caller.js";
  * A class that extends the BaseDocumentLoader and implements the
  * DocumentLoader interface. It represents a document loader for loading
  * web-based documents using Cheerio.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export class CheerioWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, fields) {

package/dist/document_loaders/web/college_confidential.cjs

@@ -6,6 +6,12 @@ const cheerio_js_1 = require("./cheerio.cjs");
 /**
  * A document loader specifically designed for loading documents from the
  * College Confidential website. It extends the CheerioWebBaseLoader.
+ * @example
+ * ```typescript
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 class CollegeConfidentialLoader extends cheerio_js_1.CheerioWebBaseLoader {
     constructor(webPath) {

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

@@ -3,6 +3,12 @@ import { CheerioWebBaseLoader } from "./cheerio.js";
 /**
  * A document loader specifically designed for loading documents from the
  * College Confidential website. It extends the CheerioWebBaseLoader.
+ * @example
+ * ```typescript
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export declare class CollegeConfidentialLoader extends CheerioWebBaseLoader {
     constructor(webPath: string);

package/dist/document_loaders/web/college_confidential.js

@@ -3,6 +3,12 @@ import { CheerioWebBaseLoader } from "./cheerio.js";
 /**
  * A document loader specifically designed for loading documents from the
  * College Confidential website. It extends the CheerioWebBaseLoader.
+ * @example
+ * ```typescript
+ * const loader = new CollegeConfidentialLoader("https:exampleurl.com");
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export class CollegeConfidentialLoader extends CheerioWebBaseLoader {
     constructor(webPath) {

package/dist/document_loaders/web/confluence.cjs

@@ -6,6 +6,17 @@ const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
 /**
  * Class representing a document loader for loading pages from Confluence.
+ * @example
+ * ```typescript
+ * const loader = new ConfluencePagesLoader({
+ *   baseUrl: "https:
+ *   spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
+ *   username: "your-username",
+ *   accessToken: "your-access-token",
+ * });
+ * const documents = await loader.load();
+ * console.log(documents);
+ * ```
  */
 class ConfluencePagesLoader extends base_js_1.BaseDocumentLoader {
     constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {

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

@@ -32,6 +32,17 @@ export interface ConfluenceAPIResponse {
 }
 /**
  * Class representing a document loader for loading pages from Confluence.
+ * @example
+ * ```typescript
+ * const loader = new ConfluencePagesLoader({
+ *   baseUrl: "https:
+ *   spaceKey: "~EXAMPLE362906de5d343d49dcdbae5dEXAMPLE",
+ *   username: "your-username",
+ *   accessToken: "your-access-token",
+ * });
+ * const documents = await loader.load();
+ * console.log(documents);
+ * ```
  */
 export declare class ConfluencePagesLoader extends BaseDocumentLoader {
     readonly baseUrl: string;