@langchain/google-common 0.2.18 → 1.0.0

package/dist/chat_models.js

@@ -1,463 +1,251 @@
+import { removeAdditionalProperties, schemaToGeminiParameters } from "./utils/zod_to_gemini_parameters.js";
+import { DefaultGeminiSafetyHandler, getGeminiAPI } from "./utils/gemini.js";
+import { convertToGeminiTools, copyAIModelParams, copyAndValidateModelParamsInto } from "./utils/common.js";
+import { ensureParams } from "./utils/failed_handler.js";
+import { AbstractGoogleLLMConnection } from "./connection.js";
+import { ApiKeyGoogleAuth } from "./auth.js";
 import { getEnvironmentVariable } from "@langchain/core/utils/env";
-import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
+import { BaseChatModel } from "@langchain/core/language_models/chat_models";
 import { ChatGenerationChunk } from "@langchain/core/outputs";
 import { AIMessageChunk } from "@langchain/core/messages";
-import { RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
+import { RunnablePassthrough, RunnableSequence } from "@langchain/core/runnables";
 import { JsonOutputKeyToolsParser } from "@langchain/core/output_parsers/openai_tools";
 import { concat } from "@langchain/core/utils/stream";
-import { isInteropZodSchema, } from "@langchain/core/utils/types";
-import { convertToGeminiTools, copyAIModelParams, copyAndValidateModelParamsInto, } from "./utils/common.js";
-import { AbstractGoogleLLMConnection } from "./connection.js";
-import { DefaultGeminiSafetyHandler, getGeminiAPI } from "./utils/gemini.js";
-import { ApiKeyGoogleAuth } from "./auth.js";
-import { ensureParams } from "./utils/failed_handler.js";
-import { removeAdditionalProperties, schemaToGeminiParameters, } from "./utils/zod_to_gemini_parameters.js";
-export class ChatConnection extends AbstractGoogleLLMConnection {
-    constructor(fields, caller, client, streaming) {
-        super(fields, caller, client, streaming);
-        Object.defineProperty(this, "convertSystemMessageToHumanContent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.convertSystemMessageToHumanContent =
-            fields?.convertSystemMessageToHumanContent;
-    }
-    get useSystemInstruction() {
-        return typeof this.convertSystemMessageToHumanContent === "boolean"
-            ? !this.convertSystemMessageToHumanContent
-            : this.computeUseSystemInstruction;
-    }
-    get computeUseSystemInstruction() {
-        // This works on models from April 2024 and later
-        //   Vertex AI: gemini-1.5-pro and gemini-1.0-002 and later
-        //   AI Studio: gemini-1.5-pro-latest
-        if (this.modelFamily === "palm") {
-            return false;
-        }
-        else if (this.modelName === "gemini-1.0-pro-001") {
-            return false;
-        }
-        else if (this.modelName.startsWith("gemini-pro-vision")) {
-            return false;
-        }
-        else if (this.modelName.startsWith("gemini-1.0-pro-vision")) {
-            return false;
-        }
-        else if (this.modelName === "gemini-pro" && this.platform === "gai") {
-            // on AI Studio gemini-pro is still pointing at gemini-1.0-pro-001
-            return false;
-        }
-        else if (this.modelFamily === "gemma") {
-            // At least as of 12 Mar 2025 gemma 3 on AIS, trying to use system instructions yields an error:
-            // "Developer instruction is not enabled for models/gemma-3-27b-it"
-            return false;
-        }
-        return true;
-    }
-    computeGoogleSearchToolAdjustmentFromModel() {
-        if (this.modelName.startsWith("gemini-1.0")) {
-            return "googleSearchRetrieval";
-        }
-        else if (this.modelName.startsWith("gemini-1.5")) {
-            return "googleSearchRetrieval";
-        }
-        else {
-            return "googleSearch";
-        }
-    }
-    computeGoogleSearchToolAdjustment(apiConfig) {
-        const adj = apiConfig.googleSearchToolAdjustment;
-        if (adj === undefined || adj === true) {
-            return this.computeGoogleSearchToolAdjustmentFromModel();
-        }
-        else {
-            return adj;
-        }
-    }
-    buildGeminiAPI() {
-        const apiConfig = this.apiConfig ?? {};
-        const googleSearchToolAdjustment = this.computeGoogleSearchToolAdjustment(apiConfig);
-        const geminiConfig = {
-            useSystemInstruction: this.useSystemInstruction,
-            googleSearchToolAdjustment,
-            ...apiConfig,
-        };
-        return getGeminiAPI(geminiConfig);
-    }
-    get api() {
-        switch (this.apiName) {
-            case "google":
-                return this.buildGeminiAPI();
-            default:
-                return super.api;
-        }
-    }
-}
+import { isInteropZodSchema } from "@langchain/core/utils/types";
+
+//#region src/chat_models.ts
+var ChatConnection = class extends AbstractGoogleLLMConnection {
+	convertSystemMessageToHumanContent;
+	constructor(fields, caller, client, streaming) {
+		super(fields, caller, client, streaming);
+		this.convertSystemMessageToHumanContent = fields?.convertSystemMessageToHumanContent;
+	}
+	get useSystemInstruction() {
+		return typeof this.convertSystemMessageToHumanContent === "boolean" ? !this.convertSystemMessageToHumanContent : this.computeUseSystemInstruction;
+	}
+	get computeUseSystemInstruction() {
+		if (this.modelFamily === "palm") return false;
+		else if (this.modelName === "gemini-1.0-pro-001") return false;
+		else if (this.modelName.startsWith("gemini-pro-vision")) return false;
+		else if (this.modelName.startsWith("gemini-1.0-pro-vision")) return false;
+		else if (this.modelName === "gemini-pro" && this.platform === "gai") return false;
+		else if (this.modelFamily === "gemma") return false;
+		return true;
+	}
+	computeGoogleSearchToolAdjustmentFromModel() {
+		if (this.modelName.startsWith("gemini-1.0")) return "googleSearchRetrieval";
+		else if (this.modelName.startsWith("gemini-1.5")) return "googleSearchRetrieval";
+		else return "googleSearch";
+	}
+	computeGoogleSearchToolAdjustment(apiConfig) {
+		const adj = apiConfig.googleSearchToolAdjustment;
+		if (adj === void 0 || adj === true) return this.computeGoogleSearchToolAdjustmentFromModel();
+		else return adj;
+	}
+	buildGeminiAPI() {
+		const apiConfig = this.apiConfig ?? {};
+		const googleSearchToolAdjustment = this.computeGoogleSearchToolAdjustment(apiConfig);
+		const geminiConfig = {
+			useSystemInstruction: this.useSystemInstruction,
+			googleSearchToolAdjustment,
+			...apiConfig
+		};
+		return getGeminiAPI(geminiConfig);
+	}
+	get api() {
+		switch (this.apiName) {
+			case "google": return this.buildGeminiAPI();
+			default: return super.api;
+		}
+	}
+};
 /**
- * Integration with a Google chat model.
- */
-export class ChatGoogleBase extends BaseChatModel {
-    // Used for tracing, replace with the same name as your class
-    static lc_name() {
-        return "ChatGoogle";
-    }
-    get lc_secrets() {
-        return {
-            authOptions: "GOOGLE_AUTH_OPTIONS",
-        };
-    }
-    constructor(fields) {
-        super(ensureParams(fields));
-        Object.defineProperty(this, "lc_serializable", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        // Set based on modelName
-        Object.defineProperty(this, "model", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "modelName", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "gemini-pro"
-        });
-        Object.defineProperty(this, "temperature", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "maxOutputTokens", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "maxReasoningTokens", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "topP", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "topK", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "seed", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "presencePenalty", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "frequencyPenalty", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "stopSequences", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "logprobs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "topLogprobs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 0
-        });
-        Object.defineProperty(this, "safetySettings", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "responseModalities", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        // May intentionally be undefined, meaning to compute this.
-        Object.defineProperty(this, "convertSystemMessageToHumanContent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "safetyHandler", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "speechConfig", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "streamUsage", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        Object.defineProperty(this, "streaming", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "labels", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "connection", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "streamedConnection", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        copyAndValidateModelParamsInto(fields, this);
-        this.safetyHandler =
-            fields?.safetyHandler ?? new DefaultGeminiSafetyHandler();
-        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
-        const client = this.buildClient(fields);
-        this.buildConnection(fields ?? {}, client);
-    }
-    getLsParams(options) {
-        const params = this.invocationParams(options);
-        return {
-            ls_provider: "google_vertexai",
-            ls_model_name: this.model,
-            ls_model_type: "chat",
-            ls_temperature: params.temperature ?? undefined,
-            ls_max_tokens: params.maxOutputTokens ?? undefined,
-            ls_stop: options.stop,
-        };
-    }
-    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);
-        }
-    }
-    buildConnection(fields, client) {
-        this.connection = new ChatConnection({ ...fields, ...this }, this.caller, client, false);
-        this.streamedConnection = new ChatConnection({ ...fields, ...this }, this.caller, client, true);
-    }
-    get platform() {
-        return this.connection.platform;
-    }
-    bindTools(tools, kwargs) {
-        return this.withConfig({ tools: convertToGeminiTools(tools), ...kwargs });
-    }
-    // Replace
-    _llmType() {
-        return "chat_integration";
-    }
-    /**
-     * Get the parameters used to invoke the model
-     */
-    invocationParams(options) {
-        return copyAIModelParams(this, options);
-    }
-    async _generate(messages, options, runManager) {
-        const parameters = this.invocationParams(options);
-        if (this.streaming) {
-            const stream = this._streamResponseChunks(messages, options, runManager);
-            let finalChunk = null;
-            for await (const chunk of stream) {
-                finalChunk = !finalChunk ? chunk : concat(finalChunk, chunk);
-            }
-            if (!finalChunk) {
-                throw new Error("No chunks were returned from the stream.");
-            }
-            return {
-                generations: [finalChunk],
-            };
-        }
-        const response = await this.connection.request(messages, parameters, options, runManager);
-        const ret = this.connection.api.responseToChatResult(response);
-        const chunk = ret?.generations?.[0];
-        if (chunk) {
-            await runManager?.handleLLMNewToken(chunk.text || "");
-        }
-        return ret;
-    }
-    async *_streamResponseChunks(_messages, options, runManager) {
-        // Make the call as a streaming request
-        const parameters = this.invocationParams(options);
-        const response = await this.streamedConnection.request(_messages, parameters, options, runManager);
-        // Get the streaming parser of the response
-        const stream = response.data;
-        let usageMetadata;
-        // Loop until the end of the stream
-        // During the loop, yield each time we get a chunk from the streaming parser
-        // that is either available or added to the queue
-        while (!stream.streamDone) {
-            const output = await stream.nextChunk();
-            await runManager?.handleCustomEvent(`google-chunk-${this.constructor.name}`, {
-                output,
-            });
-            if (output &&
-                output.usageMetadata &&
-                this.streamUsage !== false &&
-                options.streamUsage !== false) {
-                usageMetadata = {
-                    input_tokens: output.usageMetadata.promptTokenCount,
-                    output_tokens: output.usageMetadata.candidatesTokenCount,
-                    total_tokens: output.usageMetadata.totalTokenCount,
-                };
-            }
-            const chunk = output !== null
-                ? this.connection.api.responseToChatGeneration({ data: output })
-                : new ChatGenerationChunk({
-                    text: "",
-                    generationInfo: { finishReason: "stop" },
-                    message: new AIMessageChunk({
-                        content: "",
-                        usage_metadata: usageMetadata,
-                    }),
-                });
-            if (chunk) {
-                yield chunk;
-                await runManager?.handleLLMNewToken(chunk.text ?? "", undefined, undefined, undefined, undefined, { chunk });
-            }
-        }
-    }
-    /** @ignore */
-    _combineLLMOutput() {
-        return [];
-    }
-    withStructuredOutput(outputSchema, config) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const schema = outputSchema;
-        const name = config?.name;
-        const method = config?.method;
-        const includeRaw = config?.includeRaw;
-        if (method === "jsonMode") {
-            throw new Error(`Google only supports "functionCalling" as a method.`);
-        }
-        let functionName = name ?? "extract";
-        let outputParser;
-        let tools;
-        if (isInteropZodSchema(schema)) {
-            const jsonSchema = schemaToGeminiParameters(schema);
-            tools = [
-                {
-                    functionDeclarations: [
-                        {
-                            name: functionName,
-                            description: jsonSchema.description ?? "A function available to call.",
-                            parameters: jsonSchema,
-                        },
-                    ],
-                },
-            ];
-            outputParser = new JsonOutputKeyToolsParser({
-                returnSingle: true,
-                keyName: functionName,
-                zodSchema: schema,
-            });
-        }
-        else {
-            let geminiFunctionDefinition;
-            if (typeof schema.name === "string" &&
-                typeof schema.parameters === "object" &&
-                schema.parameters != null) {
-                geminiFunctionDefinition = schema;
-                functionName = schema.name;
-            }
-            else {
-                // We are providing the schema for *just* the parameters, probably
-                const parameters = removeAdditionalProperties(schema);
-                geminiFunctionDefinition = {
-                    name: functionName,
-                    description: schema.description ?? "",
-                    parameters,
-                };
-            }
-            tools = [
-                {
-                    functionDeclarations: [geminiFunctionDefinition],
-                },
-            ];
-            outputParser = new JsonOutputKeyToolsParser({
-                returnSingle: true,
-                keyName: functionName,
-            });
-        }
-        const llm = this.bindTools(tools).withConfig({ tool_choice: functionName });
-        if (!includeRaw) {
-            return llm.pipe(outputParser).withConfig({
-                runName: "ChatGoogleStructuredOutput",
-            });
-        }
-        const parserAssign = RunnablePassthrough.assign({
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            parsed: (input, config) => outputParser.invoke(input.raw, config),
-        });
-        const parserNone = RunnablePassthrough.assign({
-            parsed: () => null,
-        });
-        const parsedWithFallback = parserAssign.withFallbacks({
-            fallbacks: [parserNone],
-        });
-        return RunnableSequence.from([
-            {
-                raw: llm,
-            },
-            parsedWithFallback,
-        ]).withConfig({
-            runName: "StructuredOutputRunnable",
-        });
-    }
-}
+* Integration with a Google chat model.
+*/
+var ChatGoogleBase = class extends BaseChatModel {
+	static lc_name() {
+		return "ChatGoogle";
+	}
+	get lc_secrets() {
+		return { authOptions: "GOOGLE_AUTH_OPTIONS" };
+	}
+	lc_serializable = true;
+	model;
+	modelName = "gemini-pro";
+	temperature;
+	maxOutputTokens;
+	maxReasoningTokens;
+	topP;
+	topK;
+	seed;
+	presencePenalty;
+	frequencyPenalty;
+	stopSequences = [];
+	logprobs;
+	topLogprobs = 0;
+	safetySettings = [];
+	responseModalities;
+	convertSystemMessageToHumanContent;
+	safetyHandler;
+	speechConfig;
+	streamUsage = true;
+	streaming = false;
+	labels;
+	connection;
+	streamedConnection;
+	constructor(fields) {
+		super(ensureParams(fields));
+		copyAndValidateModelParamsInto(fields, this);
+		this.safetyHandler = fields?.safetyHandler ?? new DefaultGeminiSafetyHandler();
+		this.streamUsage = fields?.streamUsage ?? this.streamUsage;
+		const client = this.buildClient(fields);
+		this.buildConnection(fields ?? {}, client);
+	}
+	getLsParams(options) {
+		const params = this.invocationParams(options);
+		return {
+			ls_provider: "google_vertexai",
+			ls_model_name: this.model,
+			ls_model_type: "chat",
+			ls_temperature: params.temperature ?? void 0,
+			ls_max_tokens: params.maxOutputTokens ?? void 0,
+			ls_stop: options.stop
+		};
+	}
+	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);
+	}
+	buildConnection(fields, client) {
+		this.connection = new ChatConnection({
+			...fields,
+			...this
+		}, this.caller, client, false);
+		this.streamedConnection = new ChatConnection({
+			...fields,
+			...this
+		}, this.caller, client, true);
+	}
+	get platform() {
+		return this.connection.platform;
+	}
+	bindTools(tools, kwargs) {
+		return this.withConfig({
+			tools: convertToGeminiTools(tools),
+			...kwargs
+		});
+	}
+	_llmType() {
+		return "chat_integration";
+	}
+	/**
+	* Get the parameters used to invoke the model
+	*/
+	invocationParams(options) {
+		return copyAIModelParams(this, options);
+	}
+	async _generate(messages, options, runManager) {
+		const parameters = this.invocationParams(options);
+		if (this.streaming) {
+			const stream = this._streamResponseChunks(messages, options, runManager);
+			let finalChunk = null;
+			for await (const chunk$1 of stream) finalChunk = !finalChunk ? chunk$1 : concat(finalChunk, chunk$1);
+			if (!finalChunk) throw new Error("No chunks were returned from the stream.");
+			return { generations: [finalChunk] };
+		}
+		const response = await this.connection.request(messages, parameters, options, runManager);
+		const ret = this.connection.api.responseToChatResult(response);
+		const chunk = ret?.generations?.[0];
+		if (chunk) await runManager?.handleLLMNewToken(chunk.text || "");
+		return ret;
+	}
+	async *_streamResponseChunks(_messages, options, runManager) {
+		const parameters = this.invocationParams(options);
+		const response = await this.streamedConnection.request(_messages, parameters, options, runManager);
+		const stream = response.data;
+		let usageMetadata;
+		while (!stream.streamDone) {
+			const output = await stream.nextChunk();
+			await runManager?.handleCustomEvent(`google-chunk-${this.constructor.name}`, { output });
+			if (output && output.usageMetadata && this.streamUsage !== false && options.streamUsage !== false) usageMetadata = {
+				input_tokens: output.usageMetadata.promptTokenCount,
+				output_tokens: output.usageMetadata.candidatesTokenCount,
+				total_tokens: output.usageMetadata.totalTokenCount
+			};
+			const chunk = output !== null ? this.connection.api.responseToChatGeneration({ data: output }) : new ChatGenerationChunk({
+				text: "",
+				generationInfo: { finishReason: "stop" },
+				message: new AIMessageChunk({
+					content: "",
+					usage_metadata: usageMetadata
+				})
+			});
+			if (chunk) {
+				yield chunk;
+				await runManager?.handleLLMNewToken(chunk.text ?? "", void 0, void 0, void 0, void 0, { chunk });
+			}
+		}
+	}
+	/** @ignore */
+	_combineLLMOutput() {
+		return [];
+	}
+	withStructuredOutput(outputSchema, config) {
+		const schema = outputSchema;
+		const name = config?.name;
+		const method = config?.method;
+		const includeRaw = config?.includeRaw;
+		if (method === "jsonMode") throw new Error(`Google only supports "functionCalling" as a method.`);
+		let functionName = name ?? "extract";
+		let outputParser;
+		let tools;
+		if (isInteropZodSchema(schema)) {
+			const jsonSchema = schemaToGeminiParameters(schema);
+			tools = [{ functionDeclarations: [{
+				name: functionName,
+				description: jsonSchema.description ?? "A function available to call.",
+				parameters: jsonSchema
+			}] }];
+			outputParser = new JsonOutputKeyToolsParser({
+				returnSingle: true,
+				keyName: functionName,
+				zodSchema: schema
+			});
+		} else {
+			let geminiFunctionDefinition;
+			if (typeof schema.name === "string" && typeof schema.parameters === "object" && schema.parameters != null) {
+				geminiFunctionDefinition = schema;
+				functionName = schema.name;
+			} else {
+				const parameters = removeAdditionalProperties(schema);
+				geminiFunctionDefinition = {
+					name: functionName,
+					description: schema.description ?? "",
+					parameters
+				};
+			}
+			tools = [{ functionDeclarations: [geminiFunctionDefinition] }];
+			outputParser = new JsonOutputKeyToolsParser({
+				returnSingle: true,
+				keyName: functionName
+			});
+		}
+		const llm = this.bindTools(tools).withConfig({ tool_choice: functionName });
+		if (!includeRaw) return llm.pipe(outputParser).withConfig({ runName: "ChatGoogleStructuredOutput" });
+		const parserAssign = RunnablePassthrough.assign({ parsed: (input, config$1) => outputParser.invoke(input.raw, config$1) });
+		const parserNone = RunnablePassthrough.assign({ parsed: () => null });
+		const parsedWithFallback = parserAssign.withFallbacks({ fallbacks: [parserNone] });
+		return RunnableSequence.from([{ raw: llm }, parsedWithFallback]).withConfig({ runName: "StructuredOutputRunnable" });
+	}
+};
+
+//#endregion
+export { ChatConnection, ChatGoogleBase };
+//# sourceMappingURL=chat_models.js.map