langchain 0.0.130 → 0.0.132

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

@@ -3,12 +3,24 @@ import * as fsDefault from "node:fs";
 import { S3ClientConfig } from "@aws-sdk/client-s3";
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoader as UnstructuredLoaderDefault } from "../fs/unstructured.js";
+/**
+ * Represents the configuration options for the S3 client. It extends the
+ * S3ClientConfig interface from the "@aws-sdk/client-s3" package and
+ * includes additional deprecated properties for access key ID and secret
+ * access key.
+ */
 export type S3Config = S3ClientConfig & {
     /** @deprecated Use the credentials object instead */
     accessKeyId?: string;
     /** @deprecated Use the credentials object instead */
     secretAccessKey?: string;
 };
+/**
+ * Represents the parameters for the S3Loader class. It includes
+ * properties such as the S3 bucket, key, unstructured API URL,
+ * unstructured API key, S3 configuration, file system module, and
+ * UnstructuredLoader module.
+ */
 export interface S3LoaderParams {
     bucket: string;
     key: string;
@@ -23,6 +35,10 @@ export interface S3LoaderParams {
     fs?: typeof fsDefault;
     UnstructuredLoader?: typeof UnstructuredLoaderDefault;
 }
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 export declare class S3Loader extends BaseDocumentLoader {
     private bucket;
     private key;
@@ -32,5 +48,10 @@ export declare class S3Loader extends BaseDocumentLoader {
     private _fs;
     private _UnstructuredLoader;
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config, fs, UnstructuredLoader, }: S3LoaderParams);
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     load(): Promise<import("../../document.js").Document<Record<string, any>>[]>;
 }

package/dist/document_loaders/web/s3.js

@@ -5,6 +5,10 @@ import { Readable } from "node:stream";
 import { S3Client, GetObjectCommand } from "@aws-sdk/client-s3";
 import { BaseDocumentLoader } from "../base.js";
 import { UnstructuredLoader as UnstructuredLoaderDefault } from "../fs/unstructured.js";
+/**
+ * A class that extends the BaseDocumentLoader class. It represents a
+ * document loader for loading files from an S3 bucket.
+ */
 export class S3Loader extends BaseDocumentLoader {
     constructor({ bucket, key, unstructuredAPIURL, unstructuredAPIKey, s3Config = {}, fs = fsDefault, UnstructuredLoader = UnstructuredLoaderDefault, }) {
         super();
@@ -58,6 +62,11 @@ export class S3Loader extends BaseDocumentLoader {
         this._fs = fs;
         this._UnstructuredLoader = UnstructuredLoader;
     }
+    /**
+     * Loads the file from the S3 bucket, saves it to a temporary directory,
+     * and then uses the UnstructuredLoader to load the file as a document.
+     * @returns An array of Document objects representing the loaded documents.
+     */
     async load() {
         const tempDir = this._fs.mkdtempSync(path.join(os.tmpdir(), "s3fileloader-"));
         const filePath = path.join(tempDir, this.key);

package/dist/document_loaders/web/serpapi.cjs

@@ -4,6 +4,10 @@ exports.SerpAPILoader = void 0;
 const env_js_1 = require("../../util/env.cjs");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 class SerpAPILoader extends base_js_1.BaseDocumentLoader {
     constructor(params) {
         super();

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

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Interface representing the parameters for the SerpAPI loader. It
+ * includes properties such as the search query and the API key.
+ */
 interface SerpAPIParameters {
     /**
      * Search Query
@@ -7,6 +11,10 @@ interface SerpAPIParameters {
     q: string;
     apiKey?: string;
 }
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 export declare class SerpAPILoader extends BaseDocumentLoader {
     private apiKey;
     private searchQuery;

package/dist/document_loaders/web/serpapi.js

@@ -1,6 +1,10 @@
 import { getEnvironmentVariable } from "../../util/env.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading search results from
+ * the SerpAPI. It extends the BaseDocumentLoader class.
+ */
 export class SerpAPILoader extends BaseDocumentLoader {
     constructor(params) {
         super();

package/dist/document_loaders/web/sonix_audio.cjs

@@ -4,6 +4,10 @@ exports.SonixAudioTranscriptionLoader = void 0;
 const sonix_speech_recognition_1 = require("sonix-speech-recognition");
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 class SonixAudioTranscriptionLoader extends base_js_1.BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {
         super();
@@ -22,6 +26,12 @@ class SonixAudioTranscriptionLoader extends base_js_1.BaseDocumentLoader {
         this.sonixSpeechRecognitionService = new sonix_speech_recognition_1.SonixSpeechRecognitionService(sonixAuthKey);
         this.speechToTextRequest = speechToTextRequest;
     }
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     async load() {
         const { text, status, error } = await this.sonixSpeechRecognitionService.speechToText(this.speechToTextRequest);
         if (status === "failed") {

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

@@ -1,6 +1,10 @@
 import { SpeechToTextRequest } from "sonix-speech-recognition/lib/types.js";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 export declare class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     private readonly sonixSpeechRecognitionService;
     private readonly speechToTextRequest;
@@ -8,5 +12,11 @@ export declare class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
         sonixAuthKey: string;
         request: SpeechToTextRequest;
     });
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/sonix_audio.js

@@ -1,6 +1,10 @@
 import { SonixSpeechRecognitionService } from "sonix-speech-recognition";
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * A class that represents a document loader for transcribing audio files
+ * using the Sonix Speech Recognition service.
+ */
 export class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
     constructor({ sonixAuthKey, request: speechToTextRequest, }) {
         super();
@@ -19,6 +23,12 @@ export class SonixAudioTranscriptionLoader extends BaseDocumentLoader {
         this.sonixSpeechRecognitionService = new SonixSpeechRecognitionService(sonixAuthKey);
         this.speechToTextRequest = speechToTextRequest;
     }
+    /**
+     * Performs the speech-to-text transcription using the
+     * SonixSpeechRecognitionService and returns the transcribed text as a
+     * Document object.
+     * @returns An array of Document objects containing the transcribed text.
+     */
     async load() {
         const { text, status, error } = await this.sonixSpeechRecognitionService.speechToText(this.speechToTextRequest);
         if (status === "failed") {

package/dist/document_loaders/web/sort_xyz_blockchain.cjs

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SortXYZBlockchainLoader = void 0;
 const document_js_1 = require("../../document.cjs");
 const base_js_1 = require("../base.cjs");
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 class SortXYZBlockchainLoader extends base_js_1.BaseDocumentLoader {
     constructor({ apiKey, query }) {
         super();
@@ -56,6 +60,12 @@ class SortXYZBlockchainLoader extends base_js_1.BaseDocumentLoader {
             this.limit = query.limit ?? 100;
         }
     }
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     async load() {
         if (this.limit > 1000) {
             throw new Error(`Limit is set too high. Please set limit to 1000 or lower.`);

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

@@ -11,10 +11,17 @@ export interface Query {
     blockchain: "ethereum" | "polygon" | "goerli";
     limit?: number;
 }
+/**
+ * Interface representing the parameters for the SortXYZBlockchainLoader
+ * class.
+ */
 export interface SortXYZBlockchainLoaderParams {
     apiKey: string;
     query: Query | string;
 }
+/**
+ * Interface representing the response from the SortXYZ API.
+ */
 export interface SortXYZBlockchainAPIResponse {
     code: number;
     data: {
@@ -25,6 +32,10 @@ export interface SortXYZBlockchainAPIResponse {
         recordCount: number;
     };
 }
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 export declare class SortXYZBlockchainLoader extends BaseDocumentLoader {
     readonly contractAddress: string;
     readonly blockchain: string;
@@ -33,5 +44,11 @@ export declare class SortXYZBlockchainLoader extends BaseDocumentLoader {
     readonly sql: string;
     readonly limit: number;
     constructor({ apiKey, query }: SortXYZBlockchainLoaderParams);
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     load(): Promise<Document[]>;
 }

package/dist/document_loaders/web/sort_xyz_blockchain.js

@@ -1,5 +1,9 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Class representing a document loader for loading data from the SortXYZ
+ * blockchain using the SortXYZ API.
+ */
 export class SortXYZBlockchainLoader extends BaseDocumentLoader {
     constructor({ apiKey, query }) {
         super();
@@ -53,6 +57,12 @@ export class SortXYZBlockchainLoader extends BaseDocumentLoader {
             this.limit = query.limit ?? 100;
         }
     }
+    /**
+     * Method that loads the data from the SortXYZ blockchain based on the
+     * specified query parameters. It makes requests to the SortXYZ API and
+     * returns an array of Documents representing the retrieved data.
+     * @returns Promise<Document[]> - An array of Documents representing the retrieved data.
+     */
     async load() {
         if (this.limit > 1000) {
             throw new Error(`Limit is set too high. Please set limit to 1000 or lower.`);

package/dist/document_loaders/web/youtube.cjs

@@ -5,6 +5,11 @@ const youtube_transcript_1 = require("youtube-transcript");
 const youtubei_js_1 = require("youtubei.js");
 const document_js_1 = require("../../document.cjs");
 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.
+ */
 class YoutubeLoader extends base_js_1.BaseDocumentLoader {
     constructor(config) {
         super();
@@ -30,6 +35,11 @@ class YoutubeLoader extends base_js_1.BaseDocumentLoader {
         this.language = config?.language;
         this.addVideoInfo = config?.addVideoInfo ?? false;
     }
+    /**
+     * Extracts the videoId from a YouTube video URL.
+     * @param url The URL of the YouTube video.
+     * @returns The videoId of the YouTube video.
+     */
     static getVideoID(url) {
         const match = url.match(/.*(?:youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=)([^#&?]*).*/);
         if (match !== null && match[1].length === 11) {
@@ -39,10 +49,23 @@ class YoutubeLoader extends base_js_1.BaseDocumentLoader {
             throw new Error("Failed to get youtube video id from the url");
         }
     }
+    /**
+     * Creates a new instance of the YoutubeLoader class from a YouTube video
+     * URL.
+     * @param url The URL of the YouTube video.
+     * @param config Optional configuration options for the YoutubeLoader instance, excluding the videoId.
+     * @returns A new instance of the YoutubeLoader class.
+     */
     static createFromUrl(url, config) {
         const videoId = YoutubeLoader.getVideoID(url);
         return new YoutubeLoader({ ...config, videoId });
     }
+    /**
+     * Loads the transcript and video metadata from the specified YouTube
+     * video. It uses the youtube-transcript library to fetch the transcript
+     * and the youtubei.js library to fetch the video metadata.
+     * @returns An array of Documents representing the retrieved data.
+     */
     async load() {
         let transcript;
         const metadata = {

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

@@ -1,17 +1,44 @@
 import { Document } from "../../document.js";
 import { BaseDocumentLoader } from "../base.js";
+/**
+ * Configuration options for the YoutubeLoader class. Includes properties
+ * such as the videoId, language, and addVideoInfo.
+ */
 interface YoutubeConfig {
     videoId: string;
     language?: string;
     addVideoInfo?: boolean;
 }
+/**
+ * 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.
+ */
 export declare class YoutubeLoader extends BaseDocumentLoader {
     private videoId;
     private language?;
     private addVideoInfo;
     constructor(config: YoutubeConfig);
+    /**
+     * Extracts the videoId from a YouTube video URL.
+     * @param url The URL of the YouTube video.
+     * @returns The videoId of the YouTube video.
+     */
     private static getVideoID;
+    /**
+     * Creates a new instance of the YoutubeLoader class from a YouTube video
+     * URL.
+     * @param url The URL of the YouTube video.
+     * @param config Optional configuration options for the YoutubeLoader instance, excluding the videoId.
+     * @returns A new instance of the YoutubeLoader class.
+     */
     static createFromUrl(url: string, config?: Omit<YoutubeConfig, "videoId">): YoutubeLoader;
+    /**
+     * Loads the transcript and video metadata from the specified YouTube
+     * video. It uses the youtube-transcript library to fetch the transcript
+     * and the youtubei.js library to fetch the video metadata.
+     * @returns An array of Documents representing the retrieved data.
+     */
     load(): Promise<Document[]>;
 }
 export {};

package/dist/document_loaders/web/youtube.js

@@ -2,6 +2,11 @@ import { YoutubeTranscript } from "youtube-transcript";
 import { Innertube } from "youtubei.js";
 import { Document } from "../../document.js";
 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.
+ */
 export class YoutubeLoader extends BaseDocumentLoader {
     constructor(config) {
         super();
@@ -27,6 +32,11 @@ export class YoutubeLoader extends BaseDocumentLoader {
         this.language = config?.language;
         this.addVideoInfo = config?.addVideoInfo ?? false;
     }
+    /**
+     * Extracts the videoId from a YouTube video URL.
+     * @param url The URL of the YouTube video.
+     * @returns The videoId of the YouTube video.
+     */
     static getVideoID(url) {
         const match = url.match(/.*(?:youtu.be\/|v\/|u\/\w\/|embed\/|watch\?v=)([^#&?]*).*/);
         if (match !== null && match[1].length === 11) {
@@ -36,10 +46,23 @@ export class YoutubeLoader extends BaseDocumentLoader {
             throw new Error("Failed to get youtube video id from the url");
         }
     }
+    /**
+     * Creates a new instance of the YoutubeLoader class from a YouTube video
+     * URL.
+     * @param url The URL of the YouTube video.
+     * @param config Optional configuration options for the YoutubeLoader instance, excluding the videoId.
+     * @returns A new instance of the YoutubeLoader class.
+     */
     static createFromUrl(url, config) {
         const videoId = YoutubeLoader.getVideoID(url);
         return new YoutubeLoader({ ...config, videoId });
     }
+    /**
+     * Loads the transcript and video metadata from the specified YouTube
+     * video. It uses the youtube-transcript library to fetch the transcript
+     * and the youtubei.js library to fetch the video metadata.
+     * @returns An array of Documents representing the retrieved data.
+     */
     async load() {
         let transcript;
         const metadata = {

package/dist/document_transformers/html_to_text.cjs

@@ -4,7 +4,13 @@ exports.HtmlToTextTransformer = void 0;
 const html_to_text_1 = require("html-to-text");
 const document_js_1 = require("../document.cjs");
 const document_js_2 = require("../schema/document.cjs");
+/**
+ * A transformer that converts HTML content to plain text.
+ */
 class HtmlToTextTransformer extends document_js_2.MappingDocumentTransformer {
+    static lc_name() {
+        return "HtmlToTextTransformer";
+    }
     constructor(options = {}) {
         super(options);
         Object.defineProperty(this, "options", {

package/dist/document_transformers/html_to_text.d.ts

@@ -1,8 +1,12 @@
 import type { HtmlToTextOptions } from "html-to-text";
 import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
+/**
+ * A transformer that converts HTML content to plain text.
+ */
 export declare class HtmlToTextTransformer extends MappingDocumentTransformer {
     protected options: HtmlToTextOptions;
+    static lc_name(): string;
     constructor(options?: HtmlToTextOptions);
     _transformDocument(document: Document): Promise<Document>;
 }

package/dist/document_transformers/html_to_text.js

@@ -1,7 +1,13 @@
 import { htmlToText } from "html-to-text";
 import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
+/**
+ * A transformer that converts HTML content to plain text.
+ */
 export class HtmlToTextTransformer extends MappingDocumentTransformer {
+    static lc_name() {
+        return "HtmlToTextTransformer";
+    }
     constructor(options = {}) {
         super(options);
         Object.defineProperty(this, "options", {

package/dist/document_transformers/mozilla_readability.cjs

@@ -5,7 +5,14 @@ const readability_1 = require("@mozilla/readability");
 const jsdom_1 = require("jsdom");
 const document_js_1 = require("../document.cjs");
 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.
+ */
 class MozillaReadabilityTransformer extends document_js_2.MappingDocumentTransformer {
+    static lc_name() {
+        return "MozillaReadabilityTransformer";
+    }
     constructor(options = {}) {
         super(options);
         Object.defineProperty(this, "options", {

package/dist/document_transformers/mozilla_readability.d.ts

@@ -1,8 +1,13 @@
 import { Options } from "mozilla-readability";
 import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
+/**
+ * A transformer that uses the Mozilla Readability library to extract the
+ * main content from a web page.
+ */
 export declare class MozillaReadabilityTransformer extends MappingDocumentTransformer {
     protected options: Options;
+    static lc_name(): string;
     constructor(options?: Options);
     _transformDocument(document: Document): Promise<Document>;
 }

package/dist/document_transformers/mozilla_readability.js

@@ -2,7 +2,14 @@ import { Readability } from "@mozilla/readability";
 import { JSDOM } from "jsdom";
 import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
+/**
+ * A transformer that uses the Mozilla Readability library to extract the
+ * main content from a web page.
+ */
 export class MozillaReadabilityTransformer extends MappingDocumentTransformer {
+    static lc_name() {
+        return "MozillaReadabilityTransformer";
+    }
     constructor(options = {}) {
         super(options);
         Object.defineProperty(this, "options", {

package/dist/document_transformers/openai_functions.cjs

@@ -6,7 +6,13 @@ const document_js_1 = require("../document.cjs");
 const document_js_2 = require("../schema/document.cjs");
 const index_js_1 = require("../chains/openai_functions/index.cjs");
 const openai_js_1 = require("../chat_models/openai.cjs");
+/**
+ * A transformer that tags metadata to a document using a tagging chain.
+ */
 class MetadataTagger extends document_js_2.MappingDocumentTransformer {
+    static lc_name() {
+        return "MetadataTagger";
+    }
     constructor(fields) {
         super();
         Object.defineProperty(this, "taggingChain", {

package/dist/document_transformers/openai_functions.d.ts

@@ -5,7 +5,11 @@ import { BaseChain } from "../chains/base.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
 import { TaggingChainOptions } from "../chains/openai_functions/index.js";
 import { ChatOpenAI } from "../chat_models/openai.js";
+/**
+ * A transformer that tags metadata to a document using a tagging chain.
+ */
 export declare class MetadataTagger extends MappingDocumentTransformer {
+    static lc_name(): string;
     protected taggingChain: BaseChain;
     constructor(fields: {
         taggingChain: BaseChain;

package/dist/document_transformers/openai_functions.js

@@ -3,7 +3,13 @@ import { Document } from "../document.js";
 import { MappingDocumentTransformer } from "../schema/document.js";
 import { createTaggingChain, } from "../chains/openai_functions/index.js";
 import { ChatOpenAI } from "../chat_models/openai.js";
+/**
+ * A transformer that tags metadata to a document using a tagging chain.
+ */
 export class MetadataTagger extends MappingDocumentTransformer {
+    static lc_name() {
+        return "MetadataTagger";
+    }
     constructor(fields) {
         super();
         Object.defineProperty(this, "taggingChain", {

package/dist/embeddings/base.cjs

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Embeddings = void 0;
 const async_caller_js_1 = require("../util/async_caller.cjs");
+/**
+ * An abstract class that provides methods for embedding documents and
+ * queries using LangChain.
+ */
 class Embeddings {
     constructor(params) {
         /**

package/dist/embeddings/base.d.ts

@@ -1,5 +1,13 @@
 import { AsyncCaller, AsyncCallerParams } from "../util/async_caller.js";
+/**
+ * The parameters required to initialize an instance of the Embeddings
+ * class.
+ */
 export type EmbeddingsParams = AsyncCallerParams;
+/**
+ * An abstract class that provides methods for embedding documents and
+ * queries using LangChain.
+ */
 export declare abstract class Embeddings {
     /**
      * The async caller should be used by subclasses to make any async calls,
@@ -7,6 +15,19 @@ export declare abstract class Embeddings {
      */
     caller: AsyncCaller;
     constructor(params: EmbeddingsParams);
+    /**
+     * An abstract method that takes an array of documents as input and
+     * returns a promise that resolves to an array of vectors for each
+     * document.
+     * @param documents An array of documents to be embedded.
+     * @returns A promise that resolves to an array of vectors for each document.
+     */
     abstract embedDocuments(documents: string[]): Promise<number[][]>;
+    /**
+     * An abstract method that takes a single document as input and returns a
+     * promise that resolves to a vector for the query document.
+     * @param document A single document to be embedded.
+     * @returns A promise that resolves to a vector for the query document.
+     */
     abstract embedQuery(document: string): Promise<number[]>;
 }

package/dist/embeddings/base.js

@@ -1,4 +1,8 @@
 import { AsyncCaller } from "../util/async_caller.js";
+/**
+ * An abstract class that provides methods for embedding documents and
+ * queries using LangChain.
+ */
 export class Embeddings {
     constructor(params) {
         /**

package/dist/embeddings/cache_backed.d.ts

@@ -1,6 +1,10 @@
 import { BaseStore } from "../schema/storage.js";
 import { AsyncCallerParams } from "../util/async_caller.js";
 import { Embeddings } from "./base.js";
+/**
+ * Interface for the fields required to initialize an instance of the
+ * CacheBackedEmbeddings class.
+ */
 export interface CacheBackedEmbeddingsFields extends AsyncCallerParams {
     underlyingEmbeddings: Embeddings;
     documentEmbeddingStore: BaseStore<string, number[]>;

package/dist/embeddings/cohere.d.ts

@@ -1,4 +1,8 @@
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the CohereEmbeddings class.
+ */
 export interface CohereEmbeddingsParams extends EmbeddingsParams {
     modelName: string;
     /**