langchain 0.0.192 → 0.0.194

package/dist/document_loaders/web/confluence.js

@@ -3,6 +3,17 @@ import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 /**
  * 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 class ConfluencePagesLoader extends BaseDocumentLoader {
     constructor({ baseUrl, spaceKey, username, accessToken, limit = 25, }) {

package/dist/document_loaders/web/figma.cjs

@@ -9,6 +9,15 @@ const env_js_1 = require("../../util/env.cjs");
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
  * interface. The constructor takes a config object as a parameter, which
  * contains the access token, an array of node IDs, and the file key.
+ * @example
+ * ```typescript
+ * const loader = new FigmaFileLoader({
+ *   accessToken: "FIGMA_ACCESS_TOKEN",
+ *   nodeIds: ["id1", "id2", "id3"],
+ *   fileKey: "key",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class FigmaFileLoader extends base_js_1.BaseDocumentLoader {
     constructor({ accessToken = (0, env_js_1.getEnvironmentVariable)("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {

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

@@ -39,6 +39,15 @@ export interface FigmaLoaderParams {
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
  * interface. The constructor takes a config object as a parameter, which
  * contains the access token, an array of node IDs, and the file key.
+ * @example
+ * ```typescript
+ * const loader = new FigmaFileLoader({
+ *   accessToken: "FIGMA_ACCESS_TOKEN",
+ *   nodeIds: ["id1", "id2", "id3"],
+ *   fileKey: "key",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class FigmaFileLoader extends BaseDocumentLoader implements FigmaLoaderParams {
     accessToken?: string;

package/dist/document_loaders/web/figma.js

@@ -6,6 +6,15 @@ import { getEnvironmentVariable } from "../../util/env.js";
  * extends the BaseDocumentLoader and implements the FigmaLoaderParams
  * interface. The constructor takes a config object as a parameter, which
  * contains the access token, an array of node IDs, and the file key.
+ * @example
+ * ```typescript
+ * const loader = new FigmaFileLoader({
+ *   accessToken: "FIGMA_ACCESS_TOKEN",
+ *   nodeIds: ["id1", "id2", "id3"],
+ *   fileKey: "key",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class FigmaFileLoader extends BaseDocumentLoader {
     constructor({ accessToken = getEnvironmentVariable("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {

package/dist/document_loaders/web/notionapi.cjs

@@ -24,6 +24,22 @@ exports.isDatabase = isDatabase;
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading documents from Notion using the Notion API.
+ * @example
+ * ```typescript
+ * const pageLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<PAGE_ID>",
+ *   type: "page",
+ * });
+ * const pageDocs = await pageLoader.loadAndSplit();
+ * const dbLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<DATABASE_ID>",
+ *   type: "database",
+ *   propertiesAsHeader: true,
+ * });
+ * const dbDocs = await dbLoader.load();
+ * ```
  */
 class NotionAPILoader extends base_js_1.BaseDocumentLoader {
     constructor(options) {

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

@@ -34,6 +34,22 @@ export type NotionAPILoaderOptions = {
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading documents from Notion using the Notion API.
+ * @example
+ * ```typescript
+ * const pageLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<PAGE_ID>",
+ *   type: "page",
+ * });
+ * const pageDocs = await pageLoader.loadAndSplit();
+ * const dbLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<DATABASE_ID>",
+ *   type: "database",
+ *   propertiesAsHeader: true,
+ * });
+ * const dbDocs = await dbLoader.load();
+ * ```
  */
 export declare class NotionAPILoader extends BaseDocumentLoader {
     private caller;

package/dist/document_loaders/web/notionapi.js

@@ -13,6 +13,22 @@ export const isDatabase = (res) => isDatabaseResponse(res) && isFullDatabase(res
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading documents from Notion using the Notion API.
+ * @example
+ * ```typescript
+ * const pageLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<PAGE_ID>",
+ *   type: "page",
+ * });
+ * const pageDocs = await pageLoader.loadAndSplit();
+ * const dbLoader = new NotionAPILoader({
+ *   clientOptions: { auth: "<NOTION_INTEGRATION_TOKEN>" },
+ *   id: "<DATABASE_ID>",
+ *   type: "database",
+ *   propertiesAsHeader: true,
+ * });
+ * const dbDocs = await dbLoader.load();
+ * ```
  */
 export class NotionAPILoader extends BaseDocumentLoader {
     constructor(options) {

package/dist/document_loaders/web/notiondb.cjs

@@ -4,7 +4,17 @@ exports.NotionDBLoader = void 0;
 const base_js_1 = require("../base.cjs");
 const env_js_1 = require("../../util/env.cjs");
 const NOTION_BASE_URL = "https://api.notion.com/v1";
-/** @deprecated use the `NotionAPILoader` class instead. */
+/** @deprecated use the `NotionAPILoader` class instead.
+ * @example
+ * ```typescript
+ * const loader = new NotionDBLoader({
+ *   pageSizeLimit: 10,
+ *   databaseId: "{databaseId}",
+ *   notionIntegrationToken: "{notionIntegrationToken}",
+ * });
+ * const docs = await loader.load();
+ * ```
+ */
 class NotionDBLoader extends base_js_1.BaseDocumentLoader {
     constructor({ databaseId, notionApiVersion = "2022-06-28", notionIntegrationToken = (0, env_js_1.getEnvironmentVariable)("NOTION_INTEGRATION_TOKEN"), pageSizeLimit = 50, }) {
         super();

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

@@ -11,7 +11,17 @@ export interface NotionDBLoaderParams {
     notionApiVersion?: string;
     pageSizeLimit?: number;
 }
-/** @deprecated use the `NotionAPILoader` class instead. */
+/** @deprecated use the `NotionAPILoader` class instead.
+ * @example
+ * ```typescript
+ * const loader = new NotionDBLoader({
+ *   pageSizeLimit: 10,
+ *   databaseId: "{databaseId}",
+ *   notionIntegrationToken: "{notionIntegrationToken}",
+ * });
+ * const docs = await loader.load();
+ * ```
+ */
 export declare class NotionDBLoader extends BaseDocumentLoader implements NotionDBLoaderParams {
     integrationToken: string;
     databaseId: string;

package/dist/document_loaders/web/notiondb.js

@@ -1,7 +1,17 @@
 import { BaseDocumentLoader } from "../base.js";
 import { getEnvironmentVariable } from "../../util/env.js";
 const NOTION_BASE_URL = "https://api.notion.com/v1";
-/** @deprecated use the `NotionAPILoader` class instead. */
+/** @deprecated use the `NotionAPILoader` class instead.
+ * @example
+ * ```typescript
+ * const loader = new NotionDBLoader({
+ *   pageSizeLimit: 10,
+ *   databaseId: "{databaseId}",
+ *   notionIntegrationToken: "{notionIntegrationToken}",
+ * });
+ * const docs = await loader.load();
+ * ```
+ */
 export class NotionDBLoader extends BaseDocumentLoader {
     constructor({ databaseId, notionApiVersion = "2022-06-28", notionIntegrationToken = getEnvironmentVariable("NOTION_INTEGRATION_TOKEN"), pageSizeLimit = 50, }) {
         super();

package/dist/document_loaders/web/pdf.cjs

@@ -6,6 +6,12 @@ const base_js_1 = require("../base.cjs");
 const document_js_2 = require("../../util/document.cjs");
 /**
  * A document loader for loading data from PDFs.
+ * @example
+ * ```typescript
+ * const loader = new WebPDFLoader(new Blob());
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 class WebPDFLoader extends base_js_1.BaseDocumentLoader {
     constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {

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

@@ -3,6 +3,12 @@ import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
 /**
  * A document loader for loading data from PDFs.
+ * @example
+ * ```typescript
+ * const loader = new WebPDFLoader(new Blob());
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export declare class WebPDFLoader extends BaseDocumentLoader {
     protected blob: Blob;

package/dist/document_loaders/web/pdf.js

@@ -3,6 +3,12 @@ import { BaseDocumentLoader } from "../base.js";
 import { formatDocumentsAsString } from "../../util/document.js";
 /**
  * A document loader for loading data from PDFs.
+ * @example
+ * ```typescript
+ * const loader = new WebPDFLoader(new Blob());
+ * const docs = await loader.load();
+ * console.log({ docs });
+ * ```
  */
 export class WebPDFLoader extends BaseDocumentLoader {
     constructor(blob, { splitPages = true, pdfjs = PDFLoaderImports, parsedItemSeparator = " ", } = {}) {

package/dist/document_loaders/web/puppeteer.cjs

@@ -7,6 +7,18 @@ const base_js_1 = require("../base.cjs");
  * Class that extends the BaseDocumentLoader class and implements the
  * DocumentLoader interface. It represents a document loader for scraping
  * web pages using Puppeteer.
+ * @example
+ * ```typescript
+ * const loader = new PuppeteerWebBaseLoader("https:exampleurl.com", {
+ *   launchOptions: {
+ *     headless: true,
+ *   },
+ *   gotoOptions: {
+ *     waitUntil: "domcontentloaded",
+ *   },
+ * });
+ * const screenshot = await loader.screenshot();
+ * ```
  */
 class PuppeteerWebBaseLoader extends base_js_1.BaseDocumentLoader {
     constructor(webPath, options) {

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

@@ -22,6 +22,18 @@ export type PuppeteerWebBaseLoaderOptions = {
  * Class that extends the BaseDocumentLoader class and implements the
  * DocumentLoader interface. It represents a document loader for scraping
  * web pages using Puppeteer.
+ * @example
+ * ```typescript
+ * const loader = new PuppeteerWebBaseLoader("https:exampleurl.com", {
+ *   launchOptions: {
+ *     headless: true,
+ *   },
+ *   gotoOptions: {
+ *     waitUntil: "domcontentloaded",
+ *   },
+ * });
+ * const screenshot = await loader.screenshot();
+ * ```
  */
 export declare class PuppeteerWebBaseLoader extends BaseDocumentLoader implements DocumentLoader {
     webPath: string;

package/dist/document_loaders/web/puppeteer.js

@@ -4,6 +4,18 @@ import { BaseDocumentLoader } from "../base.js";
  * Class that extends the BaseDocumentLoader class and implements the
  * DocumentLoader interface. It represents a document loader for scraping
  * web pages using Puppeteer.
+ * @example
+ * ```typescript
+ * const loader = new PuppeteerWebBaseLoader("https:exampleurl.com", {
+ *   launchOptions: {
+ *     headless: true,
+ *   },
+ *   gotoOptions: {
+ *     waitUntil: "domcontentloaded",
+ *   },
+ * });
+ * const screenshot = await loader.screenshot();
+ * ```
  */
 export class PuppeteerWebBaseLoader extends BaseDocumentLoader {
     constructor(webPath, options) {

package/dist/document_loaders/web/s3.cjs

@@ -34,6 +34,23 @@ const unstructured_js_1 = require("../fs/unstructured.cjs");
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading files from an S3 bucket.
+ * @example
+ * ```typescript
+ * const loader = new S3Loader({
+ *   bucket: "my-document-bucket-123",
+ *   key: "AccountingOverview.pdf",
+ *   s3Config: {
+ *     region: "us-east-1",
+ *     credentials: {
+ *       accessKeyId: "<YourAccessKeyId>",
+ *       secretAccessKey: "<YourSecretAccessKey>",
+ *     },
+ *   },
+ *   unstructuredAPIURL: "<YourUnstructuredAPIURL>",
+ *   unstructuredAPIKey: "<YourUnstructuredAPIKey>",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class S3Loader extends base_js_1.BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = unstructured_js_1.UnstructuredLoader, }) {

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

@@ -38,6 +38,23 @@ export interface S3LoaderParams {
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading files from an S3 bucket.
+ * @example
+ * ```typescript
+ * const loader = new S3Loader({
+ *   bucket: "my-document-bucket-123",
+ *   key: "AccountingOverview.pdf",
+ *   s3Config: {
+ *     region: "us-east-1",
+ *     credentials: {
+ *       accessKeyId: "<YourAccessKeyId>",
+ *       secretAccessKey: "<YourSecretAccessKey>",
+ *     },
+ *   },
+ *   unstructuredAPIURL: "<YourUnstructuredAPIURL>",
+ *   unstructuredAPIKey: "<YourUnstructuredAPIKey>",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class S3Loader extends BaseDocumentLoader {
     private bucket;

package/dist/document_loaders/web/s3.js

@@ -8,6 +8,23 @@ import { UnstructuredLoader as UnstructuredLoaderDefault } from "../fs/unstructu
 /**
  * A class that extends the BaseDocumentLoader class. It represents a
  * document loader for loading files from an S3 bucket.
+ * @example
+ * ```typescript
+ * const loader = new S3Loader({
+ *   bucket: "my-document-bucket-123",
+ *   key: "AccountingOverview.pdf",
+ *   s3Config: {
+ *     region: "us-east-1",
+ *     credentials: {
+ *       accessKeyId: "<YourAccessKeyId>",
+ *       secretAccessKey: "<YourSecretAccessKey>",
+ *     },
+ *   },
+ *   unstructuredAPIURL: "<YourUnstructuredAPIURL>",
+ *   unstructuredAPIKey: "<YourUnstructuredAPIKey>",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class S3Loader extends BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = UnstructuredLoaderDefault, }) {

package/dist/document_loaders/web/searchapi.cjs

@@ -7,6 +7,15 @@ const base_js_1 = require("../base.cjs");
 /**
  * Class representing a document loader for loading search results from
  * the SearchApi. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SearchApiLoader({
+ *   q: "{query}",
+ *   apiKey: "{apiKey}",
+ *   engine: "google",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class SearchApiLoader extends base_js_1.BaseDocumentLoader {
     constructor(params) {

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

@@ -24,6 +24,15 @@ type SearchApiParameters = {
 /**
  * Class representing a document loader for loading search results from
  * the SearchApi. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SearchApiLoader({
+ *   q: "{query}",
+ *   apiKey: "{apiKey}",
+ *   engine: "google",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class SearchApiLoader extends BaseDocumentLoader {
     private apiKey;

package/dist/document_loaders/web/searchapi.js

@@ -4,6 +4,15 @@ import { BaseDocumentLoader } from "../base.js";
 /**
  * Class representing a document loader for loading search results from
  * the SearchApi. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SearchApiLoader({
+ *   q: "{query}",
+ *   apiKey: "{apiKey}",
+ *   engine: "google",
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class SearchApiLoader extends BaseDocumentLoader {
     constructor(params) {

package/dist/document_loaders/web/serpapi.cjs

@@ -7,6 +7,11 @@ const base_js_1 = require("../base.cjs");
 /**
  * Class representing a document loader for loading search results from
  * the SerpAPI. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SerpAPILoader({ q: "{query}", apiKey: "{apiKey}" });
+ * const docs = await loader.load();
+ * ```
  */
 class SerpAPILoader extends base_js_1.BaseDocumentLoader {
     constructor(params) {

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

@@ -14,6 +14,11 @@ interface SerpAPIParameters {
 /**
  * Class representing a document loader for loading search results from
  * the SerpAPI. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SerpAPILoader({ q: "{query}", apiKey: "{apiKey}" });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class SerpAPILoader extends BaseDocumentLoader {
     private apiKey;

package/dist/document_loaders/web/serpapi.js

@@ -4,6 +4,11 @@ import { BaseDocumentLoader } from "../base.js";
 /**
  * Class representing a document loader for loading search results from
  * the SerpAPI. It extends the BaseDocumentLoader class.
+ * @example
+ * ```typescript
+ * const loader = new SerpAPILoader({ q: "{query}", apiKey: "{apiKey}" });
+ * const docs = await loader.load();
+ * ```
  */
 export class SerpAPILoader extends BaseDocumentLoader {
     constructor(params) {

package/dist/document_loaders/web/sonix_audio.cjs

@@ -7,6 +7,18 @@ const base_js_1 = require("../base.cjs");
 /**
  * A class that represents a document loader for transcribing audio files
  * using the Sonix Speech Recognition service.
+ * @example
+ * ```typescript
+ * const loader = new SonixAudioTranscriptionLoader({
+ *   sonixAuthKey: "SONIX_AUTH_KEY",
+ *   request: {
+ *     audioFilePath: "LOCAL_AUDIO_FILE_PATH",
+ *     fileName: "FILE_NAME",
+ *     language: "en",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 class SonixAudioTranscriptionLoader extends base_js_1.BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {

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

@@ -4,6 +4,18 @@ import { BaseDocumentLoader } from "../base.js";
 /**
  * A class that represents a document loader for transcribing audio files
  * using the Sonix Speech Recognition service.
+ * @example
+ * ```typescript
+ * const loader = new SonixAudioTranscriptionLoader({
+ *   sonixAuthKey: "SONIX_AUTH_KEY",
+ *   request: {
+ *     audioFilePath: "LOCAL_AUDIO_FILE_PATH",
+ *     fileName: "FILE_NAME",
+ *     language: "en",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export declare class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     private readonly sonixSpeechRecognitionService;

package/dist/document_loaders/web/sonix_audio.js

@@ -4,6 +4,18 @@ import { BaseDocumentLoader } from "../base.js";
 /**
  * A class that represents a document loader for transcribing audio files
  * using the Sonix Speech Recognition service.
+ * @example
+ * ```typescript
+ * const loader = new SonixAudioTranscriptionLoader({
+ *   sonixAuthKey: "SONIX_AUTH_KEY",
+ *   request: {
+ *     audioFilePath: "LOCAL_AUDIO_FILE_PATH",
+ *     fileName: "FILE_NAME",
+ *     language: "en",
+ *   },
+ * });
+ * const docs = await loader.load();
+ * ```
  */
 export class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {

package/dist/document_loaders/web/sort_xyz_blockchain.cjs

@@ -6,6 +6,28 @@ const base_js_1 = require("../base.cjs");
 /**
  * Class representing a document loader for loading data from the SortXYZ
  * blockchain using the SortXYZ API.
+ * @example
+ * ```typescript
+ * const blockchainLoader = new SortXYZBlockchainLoader({
+ *   apiKey: "YOUR_SORTXYZ_API_KEY",
+ *   query: {
+ *     type: "NFTMetadata",
+ *     blockchain: "ethereum",
+ *     contractAddress: "0x887F3909C14DAbd9e9510128cA6cBb448E932d7f".toLowerCase(),
+ *   },
+ * });
+ *
+ * const blockchainData = await blockchainLoader.load();
+ *
+ * const prompt =
+ *   "Describe the character with the attributes from the following json document in a 4 sentence story. ";
+ * const model = new ChatOpenAI({ temperature: 0.9 })
+ * const response = await model.invoke(
+ *   prompt + JSON.stringify(blockchainData[0], null, 2),
+ * );
+ * console.log(`user > ${prompt}`);
+ * console.log(`chatgpt > ${response}`);
+ * ```
  */
 class SortXYZBlockchainLoader extends base_js_1.BaseDocumentLoader {
     constructor({ apiKey, query }) {

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

@@ -35,6 +35,28 @@ export interface SortXYZBlockchainAPIResponse {
 /**
  * Class representing a document loader for loading data from the SortXYZ
  * blockchain using the SortXYZ API.
+ * @example
+ * ```typescript
+ * const blockchainLoader = new SortXYZBlockchainLoader({
+ *   apiKey: "YOUR_SORTXYZ_API_KEY",
+ *   query: {
+ *     type: "NFTMetadata",
+ *     blockchain: "ethereum",
+ *     contractAddress: "0x887F3909C14DAbd9e9510128cA6cBb448E932d7f".toLowerCase(),
+ *   },
+ * });
+ *
+ * const blockchainData = await blockchainLoader.load();
+ *
+ * const prompt =
+ *   "Describe the character with the attributes from the following json document in a 4 sentence story. ";
+ * const model = new ChatOpenAI({ temperature: 0.9 })
+ * const response = await model.invoke(
+ *   prompt + JSON.stringify(blockchainData[0], null, 2),
+ * );
+ * console.log(`user > ${prompt}`);
+ * console.log(`chatgpt > ${response}`);
+ * ```
  */
 export declare class SortXYZBlockchainLoader extends BaseDocumentLoader {
     readonly contractAddress: string;

package/dist/document_loaders/web/sort_xyz_blockchain.js

@@ -3,6 +3,28 @@ import { BaseDocumentLoader } from "../base.js";
 /**
  * Class representing a document loader for loading data from the SortXYZ
  * blockchain using the SortXYZ API.
+ * @example
+ * ```typescript
+ * const blockchainLoader = new SortXYZBlockchainLoader({
+ *   apiKey: "YOUR_SORTXYZ_API_KEY",
+ *   query: {
+ *     type: "NFTMetadata",
+ *     blockchain: "ethereum",
+ *     contractAddress: "0x887F3909C14DAbd9e9510128cA6cBb448E932d7f".toLowerCase(),
+ *   },
+ * });
+ *
+ * const blockchainData = await blockchainLoader.load();
+ *
+ * const prompt =
+ *   "Describe the character with the attributes from the following json document in a 4 sentence story. ";
+ * const model = new ChatOpenAI({ temperature: 0.9 })
+ * const response = await model.invoke(
+ *   prompt + JSON.stringify(blockchainData[0], null, 2),
+ * );
+ * console.log(`user > ${prompt}`);
+ * console.log(`chatgpt > ${response}`);
+ * ```
  */
 export class SortXYZBlockchainLoader extends BaseDocumentLoader {
     constructor({ apiKey, query }) {

package/dist/document_loaders/web/youtube.cjs

@@ -9,6 +9,15 @@ const base_js_1 = require("../base.cjs");
  * A document loader for loading data from YouTube videos. It uses the
  * youtube-transcript and youtubei.js libraries to fetch the transcript
  * and video metadata.
+ * @example
+ * ```typescript
+ * const loader = new YoutubeLoader(
+ *   "https:
+ *   "en",
+ *   true,
+ * );
+ * const docs = await loader.load();
+ * ```
  */
 class YoutubeLoader extends base_js_1.BaseDocumentLoader {
     constructor(config) {

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

@@ -13,6 +13,15 @@ interface YoutubeConfig {
  * A document loader for loading data from YouTube videos. It uses the
  * youtube-transcript and youtubei.js libraries to fetch the transcript
  * and video metadata.
+ * @example
+ * ```typescript
+ * const loader = new YoutubeLoader(
+ *   "https:
+ *   "en",
+ *   true,
+ * );
+ * const docs = await loader.load();
+ * ```
  */
 export declare class YoutubeLoader extends BaseDocumentLoader {
     private videoId;

package/dist/document_loaders/web/youtube.js

@@ -6,6 +6,15 @@ import { BaseDocumentLoader } from "../base.js";
  * A document loader for loading data from YouTube videos. It uses the
  * youtube-transcript and youtubei.js libraries to fetch the transcript
  * and video metadata.
+ * @example
+ * ```typescript
+ * const loader = new YoutubeLoader(
+ *   "https:
+ *   "en",
+ *   true,
+ * );
+ * const docs = await loader.load();
+ * ```
  */
 export class YoutubeLoader extends BaseDocumentLoader {
     constructor(config) {