@langchain/google-common 0.0.23 → 0.0.24

package/dist/connection.d.ts

@@ -28,7 +28,7 @@ export declare abstract class GoogleHostConnection<CallOptions extends AsyncCall
     get computedPlatformType(): GooglePlatformType;
     buildMethod(): GoogleAbstractedClientOpsMethod;
 }
-export declare abstract class GoogleAIConnection<CallOptions extends BaseLanguageModelCallOptions, MessageType, AuthOptions> extends GoogleHostConnection<CallOptions, GoogleLLMResponse, AuthOptions> implements GoogleAIBaseLLMInput<AuthOptions> {
+export declare abstract class GoogleAIConnection<CallOptions extends AsyncCallerCallOptions, InputType, AuthOptions, ResponseType extends GoogleResponse> extends GoogleHostConnection<CallOptions, ResponseType, AuthOptions> implements GoogleAIBaseLLMInput<AuthOptions> {
     model: string;
     modelName: string;
     client: GoogleAbstractedClient;
@@ -39,10 +39,10 @@ export declare abstract class GoogleAIConnection<CallOptions extends BaseLanguag
     buildUrlGenerativeLanguage(): Promise<string>;
     buildUrlVertex(): Promise<string>;
     buildUrl(): Promise<string>;
-    abstract formatData(input: MessageType, parameters: GoogleAIModelRequestParams): unknown;
-    request(input: MessageType, parameters: GoogleAIModelRequestParams, options: CallOptions): Promise<GoogleLLMResponse>;
+    abstract formatData(input: InputType, parameters: GoogleAIModelRequestParams): unknown;
+    request(input: InputType, parameters: GoogleAIModelRequestParams, options: CallOptions): Promise<ResponseType>;
 }
-export declare abstract class AbstractGoogleLLMConnection<MessageType, AuthOptions> extends GoogleAIConnection<BaseLanguageModelCallOptions, MessageType, AuthOptions> {
+export declare abstract class AbstractGoogleLLMConnection<MessageType, AuthOptions> extends GoogleAIConnection<BaseLanguageModelCallOptions, MessageType, AuthOptions, GoogleLLMResponse> {
     buildUrlMethodGemini(): Promise<string>;
     buildUrlMethod(): Promise<string>;
     abstract formatContents(input: MessageType, parameters: GoogleAIModelRequestParams): GeminiContent[];

package/dist/embeddings.cjs

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseGoogleEmbeddings = void 0;
+const embeddings_1 = require("@langchain/core/embeddings");
+const chunk_array_1 = require("@langchain/core/utils/chunk_array");
+const env_1 = require("@langchain/core/utils/env");
+const connection_js_1 = require("./connection.cjs");
+const auth_js_1 = require("./auth.cjs");
+class EmbeddingsConnection extends connection_js_1.GoogleAIConnection {
+    constructor(fields, caller, client, streaming) {
+        super(fields, caller, client, streaming);
+        Object.defineProperty(this, "convertSystemMessageToHumanContent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    async buildUrlMethod() {
+        return "predict";
+    }
+    formatData(input, parameters) {
+        return {
+            instances: input,
+            parameters,
+        };
+    }
+}
+/**
+ * Enables calls to the Google Cloud's Vertex AI API to access
+ * the embeddings generated by Large Language Models.
+ *
+ * To use, you will need to have one of the following authentication
+ * methods in place:
+ * - You are logged into an account permitted to the Google Cloud project
+ *   using Vertex AI.
+ * - You are running this on a machine using a service account permitted to
+ *   the Google Cloud project using Vertex AI.
+ * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
+ *   path of a credentials file for a service account permitted to the
+ *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
+ */
+class BaseGoogleEmbeddings extends embeddings_1.Embeddings {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = fields.model;
+        this.connection = new EmbeddingsConnection({ ...fields, ...this }, this.caller, this.buildClient(fields), false);
+    }
+    buildApiKeyClient(apiKey) {
+        return new auth_js_1.ApiKeyGoogleAuth(apiKey);
+    }
+    buildApiKey(fields) {
+        return fields?.apiKey ?? (0, env_1.getEnvironmentVariable)("GOOGLE_API_KEY");
+    }
+    buildClient(fields) {
+        const apiKey = this.buildApiKey(fields);
+        if (apiKey) {
+            return this.buildApiKeyClient(apiKey);
+        }
+        else {
+            return this.buildAbstractedClient(fields);
+        }
+    }
+    /**
+     * 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_array_1.chunkArray)(documents.map((document) => ({
+            content: document,
+        })), 5); // Vertex AI accepts max 5 instances per prediction
+        const parameters = {};
+        const options = {};
+        const responses = await Promise.all(instanceChunks.map((instances) => this.connection.request(instances, parameters, options)));
+        const result = responses
+            ?.map((response) => response?.data?.predictions?.map((result) => result.embeddings.values) ?? [])
+            .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];
+    }
+}
+exports.BaseGoogleEmbeddings = BaseGoogleEmbeddings;

package/dist/embeddings.d.ts

@@ -0,0 +1,91 @@
+import { Embeddings, EmbeddingsParams } from "@langchain/core/embeddings";
+import { AsyncCallerCallOptions } from "@langchain/core/utils/async_caller";
+import { GoogleAbstractedClient } from "./auth.js";
+import { GoogleConnectionParams, GoogleResponse } from "./types.js";
+/**
+ * Defines the parameters required to initialize a
+ * GoogleEmbeddings instance. It extends EmbeddingsParams and
+ * GoogleConnectionParams.
+ */
+export interface BaseGoogleEmbeddingsParams<AuthOptions> extends EmbeddingsParams, GoogleConnectionParams<AuthOptions> {
+    model: string;
+}
+/**
+ * Defines additional options specific to the
+ * GoogleEmbeddingsInstance. It extends AsyncCallerCallOptions.
+ */
+export interface BaseGoogleEmbeddingsOptions extends AsyncCallerCallOptions {
+}
+/**
+ * Represents an instance for generating embeddings using the Google
+ * Vertex AI API. It contains the content to be embedded.
+ */
+export interface GoogleEmbeddingsInstance {
+    content: string;
+}
+/**
+ * Defines the structure of the embeddings results returned by the Google
+ * Vertex AI API. It extends GoogleBasePrediction and contains the
+ * embeddings and their statistics.
+ */
+export interface GoogleEmbeddingsResponse extends GoogleResponse {
+    data: {
+        predictions: {
+            embeddings: {
+                statistics: {
+                    token_count: number;
+                    truncated: boolean;
+                };
+                values: number[];
+            };
+        }[];
+    };
+}
+/**
+ * Enables calls to the Google Cloud's Vertex AI API to access
+ * the embeddings generated by Large Language Models.
+ *
+ * To use, you will need to have one of the following authentication
+ * methods in place:
+ * - You are logged into an account permitted to the Google Cloud project
+ *   using Vertex AI.
+ * - You are running this on a machine using a service account permitted to
+ *   the Google Cloud project using Vertex AI.
+ * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
+ *   path of a credentials file for a service account permitted to the
+ *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
+ */
+export declare abstract class BaseGoogleEmbeddings<AuthOptions> extends Embeddings implements BaseGoogleEmbeddingsParams<AuthOptions> {
+    model: string;
+    private connection;
+    constructor(fields: BaseGoogleEmbeddingsParams<AuthOptions>);
+    abstract buildAbstractedClient(fields?: GoogleConnectionParams<AuthOptions>): GoogleAbstractedClient;
+    buildApiKeyClient(apiKey: string): GoogleAbstractedClient;
+    buildApiKey(fields?: GoogleConnectionParams<AuthOptions>): string | undefined;
+    buildClient(fields?: GoogleConnectionParams<AuthOptions>): GoogleAbstractedClient;
+    /**
+     * 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.js

@@ -0,0 +1,112 @@
+import { Embeddings } from "@langchain/core/embeddings";
+import { chunkArray } from "@langchain/core/utils/chunk_array";
+import { getEnvironmentVariable } from "@langchain/core/utils/env";
+import { GoogleAIConnection } from "./connection.js";
+import { ApiKeyGoogleAuth } from "./auth.js";
+class EmbeddingsConnection extends GoogleAIConnection {
+    constructor(fields, caller, client, streaming) {
+        super(fields, caller, client, streaming);
+        Object.defineProperty(this, "convertSystemMessageToHumanContent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    async buildUrlMethod() {
+        return "predict";
+    }
+    formatData(input, parameters) {
+        return {
+            instances: input,
+            parameters,
+        };
+    }
+}
+/**
+ * Enables calls to the Google Cloud's Vertex AI API to access
+ * the embeddings generated by Large Language Models.
+ *
+ * To use, you will need to have one of the following authentication
+ * methods in place:
+ * - You are logged into an account permitted to the Google Cloud project
+ *   using Vertex AI.
+ * - You are running this on a machine using a service account permitted to
+ *   the Google Cloud project using Vertex AI.
+ * - The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to the
+ *   path of a credentials file for a service account permitted to the
+ *   Google Cloud project using Vertex AI.
+ * @example
+ * ```typescript
+ * const model = new GoogleEmbeddings();
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ * ```
+ */
+export class BaseGoogleEmbeddings extends Embeddings {
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "model", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.model = fields.model;
+        this.connection = new EmbeddingsConnection({ ...fields, ...this }, this.caller, this.buildClient(fields), false);
+    }
+    buildApiKeyClient(apiKey) {
+        return new ApiKeyGoogleAuth(apiKey);
+    }
+    buildApiKey(fields) {
+        return fields?.apiKey ?? getEnvironmentVariable("GOOGLE_API_KEY");
+    }
+    buildClient(fields) {
+        const apiKey = this.buildApiKey(fields);
+        if (apiKey) {
+            return this.buildApiKeyClient(apiKey);
+        }
+        else {
+            return this.buildAbstractedClient(fields);
+        }
+    }
+    /**
+     * 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,
+        })), 5); // Vertex AI accepts max 5 instances per prediction
+        const parameters = {};
+        const options = {};
+        const responses = await Promise.all(instanceChunks.map((instances) => this.connection.request(instances, parameters, options)));
+        const result = responses
+            ?.map((response) => response?.data?.predictions?.map((result) => result.embeddings.values) ?? [])
+            .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/index.cjs

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./chat_models.cjs"), exports);
 __exportStar(require("./llms.cjs"), exports);
+__exportStar(require("./embeddings.cjs"), exports);
 __exportStar(require("./auth.cjs"), exports);
 __exportStar(require("./connection.cjs"), exports);
 __exportStar(require("./types.cjs"), exports);

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./chat_models.js";
 export * from "./llms.js";
+export * from "./embeddings.js";
 export * from "./auth.js";
 export * from "./connection.js";
 export * from "./types.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./chat_models.js";
 export * from "./llms.js";
+export * from "./embeddings.js";
 export * from "./auth.js";
 export * from "./connection.js";
 export * from "./types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/google-common",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "Core types and classes for Google services.",
   "type": "module",
   "engines": {