langchain 0.0.131 → 0.0.132

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,6 +4,9 @@ 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";

package/dist/document_transformers/html_to_text.d.ts

@@ -1,6 +1,9 @@
 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;

package/dist/document_transformers/html_to_text.js

@@ -1,6 +1,9 @@
 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";

package/dist/document_transformers/mozilla_readability.cjs

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

package/dist/document_transformers/mozilla_readability.d.ts

@@ -1,6 +1,10 @@
 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;

package/dist/document_transformers/mozilla_readability.js

@@ -2,6 +2,10 @@ 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";

package/dist/document_transformers/openai_functions.cjs

@@ -6,6 +6,9 @@ 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";

package/dist/document_transformers/openai_functions.d.ts

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

package/dist/document_transformers/openai_functions.js

@@ -3,6 +3,9 @@ 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";

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;
     /**

package/dist/embeddings/fake.cjs

@@ -2,18 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SyntheticEmbeddings = exports.FakeEmbeddings = void 0;
 const base_js_1 = require("./base.cjs");
+/**
+ * A class that provides fake embeddings by overriding the embedDocuments
+ * and embedQuery methods to return fixed values.
+ */
 class FakeEmbeddings extends base_js_1.Embeddings {
     constructor(params) {
         super(params ?? {});
     }
+    /**
+     * Generates fixed embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of fixed embeddings for each document.
+     */
     embedDocuments(documents) {
         return Promise.resolve(documents.map(() => [0.1, 0.2, 0.3, 0.4]));
     }
+    /**
+     * Generates a fixed embedding for a query.
+     * @param _ The query to generate an embedding for.
+     * @returns A promise that resolves with a fixed embedding for the query.
+     */
     embedQuery(_) {
         return Promise.resolve([0.1, 0.2, 0.3, 0.4]);
     }
 }
 exports.FakeEmbeddings = FakeEmbeddings;
+/**
+ * A class that provides synthetic embeddings by overriding the
+ * embedDocuments and embedQuery methods to generate embeddings based on
+ * the input documents. The embeddings are generated by converting each
+ * document into chunks, calculating a numerical value for each chunk, and
+ * returning an array of these values as the embedding.
+ */
 class SyntheticEmbeddings extends base_js_1.Embeddings {
     constructor(params) {
         super(params ?? {});
@@ -25,9 +46,21 @@ class SyntheticEmbeddings extends base_js_1.Embeddings {
         });
         this.vectorSize = params?.vectorSize ?? 4;
     }
+    /**
+     * Generates synthetic embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of synthetic embeddings for each document.
+     */
     async embedDocuments(documents) {
         return Promise.all(documents.map((doc) => this.embedQuery(doc)));
     }
+    /**
+     * Generates a synthetic embedding for a document. The document is
+     * converted into chunks, a numerical value is calculated for each chunk,
+     * and an array of these values is returned as the embedding.
+     * @param document The document to generate an embedding for.
+     * @returns A promise that resolves with a synthetic embedding for the document.
+     */
     async embedQuery(document) {
         let doc = document;
         // Only use the letters (and space) from the document, and make them lower case

package/dist/embeddings/fake.d.ts

@@ -1,16 +1,53 @@
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * A class that provides fake embeddings by overriding the embedDocuments
+ * and embedQuery methods to return fixed values.
+ */
 export declare class FakeEmbeddings extends Embeddings {
     constructor(params?: EmbeddingsParams);
+    /**
+     * Generates fixed embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of fixed embeddings for each document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
+    /**
+     * Generates a fixed embedding for a query.
+     * @param _ The query to generate an embedding for.
+     * @returns A promise that resolves with a fixed embedding for the query.
+     */
     embedQuery(_: string): Promise<number[]>;
 }
+/**
+ * An interface that defines additional parameters specific to the
+ * SyntheticEmbeddings class.
+ */
 interface SyntheticEmbeddingsParams extends EmbeddingsParams {
     vectorSize: number;
 }
+/**
+ * A class that provides synthetic embeddings by overriding the
+ * embedDocuments and embedQuery methods to generate embeddings based on
+ * the input documents. The embeddings are generated by converting each
+ * document into chunks, calculating a numerical value for each chunk, and
+ * returning an array of these values as the embedding.
+ */
 export declare class SyntheticEmbeddings extends Embeddings implements SyntheticEmbeddingsParams {
     vectorSize: number;
     constructor(params?: SyntheticEmbeddingsParams);
+    /**
+     * Generates synthetic embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of synthetic embeddings for each document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
+    /**
+     * Generates a synthetic embedding for a document. The document is
+     * converted into chunks, a numerical value is calculated for each chunk,
+     * and an array of these values is returned as the embedding.
+     * @param document The document to generate an embedding for.
+     * @returns A promise that resolves with a synthetic embedding for the document.
+     */
     embedQuery(document: string): Promise<number[]>;
 }
 export {};

package/dist/embeddings/fake.js

@@ -1,15 +1,36 @@
 import { Embeddings } from "./base.js";
+/**
+ * A class that provides fake embeddings by overriding the embedDocuments
+ * and embedQuery methods to return fixed values.
+ */
 export class FakeEmbeddings extends Embeddings {
     constructor(params) {
         super(params ?? {});
     }
+    /**
+     * Generates fixed embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of fixed embeddings for each document.
+     */
     embedDocuments(documents) {
         return Promise.resolve(documents.map(() => [0.1, 0.2, 0.3, 0.4]));
     }
+    /**
+     * Generates a fixed embedding for a query.
+     * @param _ The query to generate an embedding for.
+     * @returns A promise that resolves with a fixed embedding for the query.
+     */
     embedQuery(_) {
         return Promise.resolve([0.1, 0.2, 0.3, 0.4]);
     }
 }
+/**
+ * A class that provides synthetic embeddings by overriding the
+ * embedDocuments and embedQuery methods to generate embeddings based on
+ * the input documents. The embeddings are generated by converting each
+ * document into chunks, calculating a numerical value for each chunk, and
+ * returning an array of these values as the embedding.
+ */
 export class SyntheticEmbeddings extends Embeddings {
     constructor(params) {
         super(params ?? {});
@@ -21,9 +42,21 @@ export class SyntheticEmbeddings extends Embeddings {
         });
         this.vectorSize = params?.vectorSize ?? 4;
     }
+    /**
+     * Generates synthetic embeddings for a list of documents.
+     * @param documents List of documents to generate embeddings for.
+     * @returns A promise that resolves with a list of synthetic embeddings for each document.
+     */
     async embedDocuments(documents) {
         return Promise.all(documents.map((doc) => this.embedQuery(doc)));
     }
+    /**
+     * Generates a synthetic embedding for a document. The document is
+     * converted into chunks, a numerical value is calculated for each chunk,
+     * and an array of these values is returned as the embedding.
+     * @param document The document to generate an embedding for.
+     * @returns A promise that resolves with a synthetic embedding for the document.
+     */
     async embedQuery(document) {
         let doc = document;
         // Only use the letters (and space) from the document, and make them lower case

package/dist/embeddings/googlepalm.cjs

@@ -5,6 +5,10 @@ const generativelanguage_1 = require("@google-ai/generativelanguage");
 const google_auth_library_1 = require("google-auth-library");
 const base_js_1 = require("./base.cjs");
 const env_js_1 = require("../util/env.cjs");
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Google Palm API.
+ */
 class GooglePaLMEmbeddings extends base_js_1.Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -45,9 +49,23 @@ class GooglePaLMEmbeddings extends base_js_1.Embeddings {
         });
         return res[0].embedding?.value ?? [];
     }
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embedText
+     * method with the document as the input.
+     * @param document Document for which to generate an embedding.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document) {
         return this.caller.callWithOptions({}, this._embedText.bind(this), document);
     }
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embedText method for each document in the array.
+     * @param documents Array of documents for which to generate embeddings.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents) {
         return Promise.all(documents.map((document) => this._embedText(document)));
     }

package/dist/embeddings/googlepalm.d.ts

@@ -1,4 +1,8 @@
 import { Embeddings, EmbeddingsParams } from "./base.js";
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the GooglePaLMEmbeddings class.
+ */
 export interface GooglePaLMEmbeddingsParams extends EmbeddingsParams {
     /**
      * Model Name to use
@@ -11,12 +15,30 @@ export interface GooglePaLMEmbeddingsParams extends EmbeddingsParams {
      */
     apiKey?: string;
 }
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Google Palm API.
+ */
 export declare class GooglePaLMEmbeddings extends Embeddings implements GooglePaLMEmbeddingsParams {
     apiKey?: string;
     modelName: string;
     private client;
     constructor(fields?: GooglePaLMEmbeddingsParams);
     protected _embedText(text: string): Promise<number[]>;
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embedText
+     * method with the document as the input.
+     * @param document Document for which to generate an embedding.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document: string): Promise<number[]>;
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embedText method for each document in the array.
+     * @param documents Array of documents for which to generate embeddings.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
 }

package/dist/embeddings/googlepalm.js

@@ -2,6 +2,10 @@ import { TextServiceClient } from "@google-ai/generativelanguage";
 import { GoogleAuth } from "google-auth-library";
 import { Embeddings } from "./base.js";
 import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Google Palm API.
+ */
 export class GooglePaLMEmbeddings extends Embeddings {
     constructor(fields) {
         super(fields ?? {});
@@ -42,9 +46,23 @@ export class GooglePaLMEmbeddings extends Embeddings {
         });
         return res[0].embedding?.value ?? [];
     }
+    /**
+     * Method that takes a document as input and returns a promise that
+     * resolves to an embedding for the document. It calls the _embedText
+     * method with the document as the input.
+     * @param document Document for which to generate an embedding.
+     * @returns Promise that resolves to an embedding for the input document.
+     */
     embedQuery(document) {
         return this.caller.callWithOptions({}, this._embedText.bind(this), document);
     }
+    /**
+     * Method that takes an array of documents as input and returns a promise
+     * that resolves to a 2D array of embeddings for each document. It calls
+     * the _embedText method for each document in the array.
+     * @param documents Array of documents for which to generate embeddings.
+     * @returns Promise that resolves to a 2D array of embeddings for each input document.
+     */
     embedDocuments(documents) {
         return Promise.all(documents.map((document) => this._embedText(document)));
     }

package/dist/embeddings/googlevertexai.cjs

@@ -36,6 +36,14 @@ class GoogleVertexAIEmbeddings extends base_js_1.Embeddings {
         this.model = fields?.model ?? this.model;
         this.connection = new googlevertexai_connection_js_1.GoogleVertexAIConnection({ ...fields, ...this }, this.caller);
     }
+    /**
+     * Takes an array of documents as input and returns a promise that
+     * resolves to a 2D array of embeddings for each document. It splits the
+     * documents into chunks and makes requests to the Google Vertex AI API to
+     * generate embeddings.
+     * @param documents An array of documents to be embedded.
+     * @returns A promise that resolves to a 2D array of embeddings for each document.
+     */
     async embedDocuments(documents) {
         const instanceChunks = (0, chunk_js_1.chunkArray)(documents.map((document) => ({
             content: document,
@@ -48,6 +56,13 @@ class GoogleVertexAIEmbeddings extends base_js_1.Embeddings {
             .flat() ?? [];
         return result;
     }
+    /**
+     * Takes a document as input and returns a promise that resolves to an
+     * embedding for the document. It calls the embedDocuments method with the
+     * document as the input.
+     * @param document A document to be embedded.
+     * @returns A promise that resolves to an embedding for the document.
+     */
     async embedQuery(document) {
         const data = await this.embedDocuments([document]);
         return data[0];

package/dist/embeddings/googlevertexai.d.ts

@@ -1,5 +1,10 @@
 import { Embeddings, EmbeddingsParams } from "./base.js";
 import { GoogleVertexAIConnectionParams } from "../types/googlevertexai-types.js";
+/**
+ * Defines the parameters required to initialize a
+ * GoogleVertexAIEmbeddings instance. It extends EmbeddingsParams and
+ * GoogleVertexAIConnectionParams.
+ */
 export interface GoogleVertexAIEmbeddingsParams extends EmbeddingsParams, GoogleVertexAIConnectionParams {
 }
 /**
@@ -20,6 +25,21 @@ export declare class GoogleVertexAIEmbeddings extends Embeddings implements Goog
     model: string;
     private connection;
     constructor(fields?: GoogleVertexAIEmbeddingsParams);
+    /**
+     * Takes an array of documents as input and returns a promise that
+     * resolves to a 2D array of embeddings for each document. It splits the
+     * documents into chunks and makes requests to the Google Vertex AI API to
+     * generate embeddings.
+     * @param documents An array of documents to be embedded.
+     * @returns A promise that resolves to a 2D array of embeddings for each document.
+     */
     embedDocuments(documents: string[]): Promise<number[][]>;
+    /**
+     * Takes a document as input and returns a promise that resolves to an
+     * embedding for the document. It calls the embedDocuments method with the
+     * document as the input.
+     * @param document A document to be embedded.
+     * @returns A promise that resolves to an embedding for the document.
+     */
     embedQuery(document: string): Promise<number[]>;
 }

package/dist/embeddings/googlevertexai.js

@@ -33,6 +33,14 @@ export class GoogleVertexAIEmbeddings extends Embeddings {
         this.model = fields?.model ?? this.model;
         this.connection = new GoogleVertexAIConnection({ ...fields, ...this }, this.caller);
     }
+    /**
+     * Takes an array of documents as input and returns a promise that
+     * resolves to a 2D array of embeddings for each document. It splits the
+     * documents into chunks and makes requests to the Google Vertex AI API to
+     * generate embeddings.
+     * @param documents An array of documents to be embedded.
+     * @returns A promise that resolves to a 2D array of embeddings for each document.
+     */
     async embedDocuments(documents) {
         const instanceChunks = chunkArray(documents.map((document) => ({
             content: document,
@@ -45,6 +53,13 @@ export class GoogleVertexAIEmbeddings extends Embeddings {
             .flat() ?? [];
         return result;
     }
+    /**
+     * Takes a document as input and returns a promise that resolves to an
+     * embedding for the document. It calls the embedDocuments method with the
+     * document as the input.
+     * @param document A document to be embedded.
+     * @returns A promise that resolves to an embedding for the document.
+     */
     async embedQuery(document) {
         const data = await this.embedDocuments([document]);
         return data[0];