langchain 0.0.191 → 0.0.193

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

package/dist/document_transformers/html_to_text.cjs

@@ -6,6 +6,24 @@ const document_js_1 = require("../document.cjs");
 const document_js_2 = require("../schema/document.cjs");
 /**
  * A transformer that converts HTML content to plain text.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/some-page");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 1000,
+ * });
+ * const transformer = new HtmlToTextTransformer();
+ *
+ * // The sequence of text splitting followed by HTML to text transformation
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Processing the loaded documents through the sequence
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 class HtmlToTextTransformer extends document_js_2.MappingDocumentTransformer {
     static lc_name() {

package/dist/document_transformers/html_to_text.d.ts

@@ -3,6 +3,24 @@ import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
 /**
  * A transformer that converts HTML content to plain text.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/some-page");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 1000,
+ * });
+ * const transformer = new HtmlToTextTransformer();
+ *
+ * // The sequence of text splitting followed by HTML to text transformation
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Processing the loaded documents through the sequence
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 export declare class HtmlToTextTransformer extends MappingDocumentTransformer {
     protected options: HtmlToTextOptions;

package/dist/document_transformers/html_to_text.js

@@ -3,6 +3,24 @@ import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
 /**
  * A transformer that converts HTML content to plain text.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/some-page");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 1000,
+ * });
+ * const transformer = new HtmlToTextTransformer();
+ *
+ * // The sequence of text splitting followed by HTML to text transformation
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Processing the loaded documents through the sequence
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 export class HtmlToTextTransformer extends MappingDocumentTransformer {
     static lc_name() {

package/dist/document_transformers/mozilla_readability.cjs

@@ -8,6 +8,24 @@ const document_js_2 = require("../schema/document.cjs");
 /**
  * A transformer that uses the Mozilla Readability library to extract the
  * main content from a web page.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/article");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 5000,
+ * });
+ * const transformer = new MozillaReadabilityTransformer();
+ *
+ * // The sequence processes the loaded documents through the splitter and then the transformer.
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Invoke the sequence to transform the documents into a more readable format.
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 class MozillaReadabilityTransformer extends document_js_2.MappingDocumentTransformer {
     static lc_name() {

package/dist/document_transformers/mozilla_readability.d.ts

@@ -4,6 +4,24 @@ import { MappingDocumentTransformer } from "../schema/document.js";
 /**
  * A transformer that uses the Mozilla Readability library to extract the
  * main content from a web page.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/article");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 5000,
+ * });
+ * const transformer = new MozillaReadabilityTransformer();
+ *
+ * // The sequence processes the loaded documents through the splitter and then the transformer.
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Invoke the sequence to transform the documents into a more readable format.
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 export declare class MozillaReadabilityTransformer extends MappingDocumentTransformer {
     protected options: Options;

package/dist/document_transformers/mozilla_readability.js

@@ -5,6 +5,24 @@ import { MappingDocumentTransformer } from "../schema/document.js";
 /**
  * A transformer that uses the Mozilla Readability library to extract the
  * main content from a web page.
+ * @example
+ * ```typescript
+ * const loader = new CheerioWebBaseLoader("https://example.com/article");
+ * const docs = await loader.load();
+ *
+ * const splitter = new RecursiveCharacterTextSplitter({
+ *  maxCharacterCount: 5000,
+ * });
+ * const transformer = new MozillaReadabilityTransformer();
+ *
+ * // The sequence processes the loaded documents through the splitter and then the transformer.
+ * const sequence = splitter.pipe(transformer);
+ *
+ * // Invoke the sequence to transform the documents into a more readable format.
+ * const newDocuments = await sequence.invoke(docs);
+ *
+ * console.log(newDocuments);
+ * ```
  */
 export class MozillaReadabilityTransformer extends MappingDocumentTransformer {
     static lc_name() {

package/dist/embeddings/bedrock.cjs

@@ -6,6 +6,23 @@ const base_js_1 = require("./base.cjs");
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Bedrock API.
+ * @example
+ * ```typescript
+ * const embeddings = new BedrockEmbeddings({
+ *   region: "your-aws-region",
+ *   credentials: {
+ *     accessKeyId: "your-access-key-id",
+ *     secretAccessKey: "your-secret-access-key",
+ *   },
+ *   model: "amazon.titan-embed-text-v1",
+ * });
+ *
+ * // Embed a query and log the result
+ * const res = await embeddings.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 class BedrockEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {

package/dist/embeddings/bedrock.d.ts

@@ -22,6 +22,23 @@ export interface BedrockEmbeddingsParams extends EmbeddingsParams {
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Bedrock API.
+ * @example
+ * ```typescript
+ * const embeddings = new BedrockEmbeddings({
+ *   region: "your-aws-region",
+ *   credentials: {
+ *     accessKeyId: "your-access-key-id",
+ *     secretAccessKey: "your-secret-access-key",
+ *   },
+ *   model: "amazon.titan-embed-text-v1",
+ * });
+ *
+ * // Embed a query and log the result
+ * const res = await embeddings.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export declare class BedrockEmbeddings extends Embeddings implements BedrockEmbeddingsParams {
     model: string;

package/dist/embeddings/bedrock.js

@@ -3,6 +3,23 @@ import { Embeddings } from "./base.js";
 /**
  * Class that extends the Embeddings class and provides methods for
  * generating embeddings using the Bedrock API.
+ * @example
+ * ```typescript
+ * const embeddings = new BedrockEmbeddings({
+ *   region: "your-aws-region",
+ *   credentials: {
+ *     accessKeyId: "your-access-key-id",
+ *     secretAccessKey: "your-secret-access-key",
+ *   },
+ *   model: "amazon.titan-embed-text-v1",
+ * });
+ *
+ * // Embed a query and log the result
+ * const res = await embeddings.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
  */
 export class BedrockEmbeddings extends Embeddings {
     constructor(fields) {