@langchain/google-common 0.0.17 → 0.0.19

package/dist/chat_models.cjs

@@ -5,6 +5,7 @@ const env_1 = require("@langchain/core/utils/env");
 const chat_models_1 = require("@langchain/core/language_models/chat_models");
 const outputs_1 = require("@langchain/core/outputs");
 const messages_1 = require("@langchain/core/messages");
+const base_1 = require("@langchain/core/language_models/base");
 const runnables_1 = require("@langchain/core/runnables");
 const openai_tools_1 = require("@langchain/core/output_parsers/openai_tools");
 const function_calling_1 = require("@langchain/core/utils/function_calling");
@@ -96,6 +97,14 @@ function convertToGeminiTools(structuredTools) {
                         parameters: jsonSchema,
                     };
                 }
+                if ((0, base_1.isOpenAITool)(structuredTool)) {
+                    return {
+                        name: structuredTool.function.name,
+                        description: structuredTool.function.description ??
+                            `A function available to call.`,
+                        parameters: (0, zod_to_gemini_parameters_js_1.jsonSchemaToGeminiParameters)(structuredTool.function.parameters),
+                    };
+                }
                 return structuredTool;
             }),
         },
@@ -184,6 +193,12 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "streamUsage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
         Object.defineProperty(this, "connection", {
             enumerable: true,
             configurable: true,
@@ -199,6 +214,7 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
         (0, common_js_1.copyAndValidateModelParamsInto)(fields, this);
         this.safetyHandler =
             fields?.safetyHandler ?? new gemini_js_1.DefaultGeminiSafetyHandler();
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         const client = this.buildClient(fields);
         this.buildConnection(fields ?? {}, client);
     }
@@ -260,11 +276,22 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
         const response = await this.streamedConnection.request(_messages, parameters, options);
         // 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();
+            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
                 ? (0, gemini_js_1.safeResponseToChatGeneration)({ data: output }, this.safetyHandler)
                 : new outputs_1.ChatGenerationChunk({
@@ -272,6 +299,7 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
                     generationInfo: { finishReason: "stop" },
                     message: new messages_1.AIMessageChunk({
                         content: "",
+                        usage_metadata: usageMetadata,
                     }),
                 });
             yield chunk;

package/dist/chat_models.d.ts

@@ -3,7 +3,7 @@ import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
 import { BaseChatModel, LangSmithParams, type BaseChatModelParams } from "@langchain/core/language_models/chat_models";
 import { ChatGenerationChunk, ChatResult } from "@langchain/core/outputs";
 import { AIMessageChunk } from "@langchain/core/messages";
-import { BaseLanguageModelInput, StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
+import { BaseLanguageModelInput, StructuredOutputMethodOptions, ToolDefinition } from "@langchain/core/language_models/base";
 import type { z } from "zod";
 import { Runnable } from "@langchain/core/runnables";
 import { AsyncCaller } from "@langchain/core/utils/async_caller";
@@ -23,7 +23,7 @@ declare class ChatConnection<AuthOptions> extends AbstractGoogleLLMConnection<Ba
 /**
  * Input to chat model class.
  */
-export interface ChatGoogleBaseInput<AuthOptions> extends BaseChatModelParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams, GoogleAISafetyParams {
+export interface ChatGoogleBaseInput<AuthOptions> extends BaseChatModelParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams, GoogleAISafetyParams, Pick<GoogleAIBaseLanguageModelCallOptions, "streamUsage"> {
 }
 /**
  * Integration with a chat model.
@@ -44,17 +44,18 @@ export declare abstract class ChatGoogleBase<AuthOptions> extends BaseChatModel<
     safetySettings: GoogleAISafetySetting[];
     convertSystemMessageToHumanContent: boolean | undefined;
     safetyHandler: GoogleAISafetyHandler;
+    streamUsage: boolean;
     protected connection: ChatConnection<AuthOptions>;
     protected streamedConnection: ChatConnection<AuthOptions>;
     constructor(fields?: ChatGoogleBaseInput<AuthOptions>);
-    protected getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
+    getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
     abstract buildAbstractedClient(fields?: GoogleAIBaseLLMInput<AuthOptions>): GoogleAbstractedClient;
     buildApiKeyClient(apiKey: string): GoogleAbstractedClient;
     buildApiKey(fields?: GoogleAIBaseLLMInput<AuthOptions>): string | undefined;
     buildClient(fields?: GoogleAIBaseLLMInput<AuthOptions>): GoogleAbstractedClient;
     buildConnection(fields: GoogleBaseLLMInput<AuthOptions>, client: GoogleAbstractedClient): void;
     get platform(): GooglePlatformType;
-    bindTools(tools: (StructuredToolInterface | Record<string, unknown>)[], kwargs?: Partial<GoogleAIBaseLanguageModelCallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, GoogleAIBaseLanguageModelCallOptions>;
+    bindTools(tools: (StructuredToolInterface | Record<string, unknown> | ToolDefinition)[], kwargs?: Partial<GoogleAIBaseLanguageModelCallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, GoogleAIBaseLanguageModelCallOptions>;
     _llmType(): string;
     /**
      * Get the parameters used to invoke the model

package/dist/chat_models.js

@@ -2,6 +2,7 @@ import { getEnvironmentVariable } from "@langchain/core/utils/env";
 import { BaseChatModel, } from "@langchain/core/language_models/chat_models";
 import { ChatGenerationChunk } from "@langchain/core/outputs";
 import { AIMessageChunk } from "@langchain/core/messages";
+import { isOpenAITool, } from "@langchain/core/language_models/base";
 import { RunnablePassthrough, RunnableSequence, } from "@langchain/core/runnables";
 import { JsonOutputKeyToolsParser } from "@langchain/core/output_parsers/openai_tools";
 import { isStructuredTool } from "@langchain/core/utils/function_calling";
@@ -10,7 +11,7 @@ import { AbstractGoogleLLMConnection } from "./connection.js";
 import { baseMessageToContent, safeResponseToChatGeneration, safeResponseToChatResult, DefaultGeminiSafetyHandler, } from "./utils/gemini.js";
 import { ApiKeyGoogleAuth } from "./auth.js";
 import { ensureParams } from "./utils/failed_handler.js";
-import { zodToGeminiParameters } from "./utils/zod_to_gemini_parameters.js";
+import { jsonSchemaToGeminiParameters, zodToGeminiParameters, } from "./utils/zod_to_gemini_parameters.js";
 class ChatConnection extends AbstractGoogleLLMConnection {
     constructor(fields, caller, client, streaming) {
         super(fields, caller, client, streaming);
@@ -93,6 +94,14 @@ function convertToGeminiTools(structuredTools) {
                         parameters: jsonSchema,
                     };
                 }
+                if (isOpenAITool(structuredTool)) {
+                    return {
+                        name: structuredTool.function.name,
+                        description: structuredTool.function.description ??
+                            `A function available to call.`,
+                        parameters: jsonSchemaToGeminiParameters(structuredTool.function.parameters),
+                    };
+                }
                 return structuredTool;
             }),
         },
@@ -181,6 +190,12 @@ export class ChatGoogleBase extends BaseChatModel {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "streamUsage", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
         Object.defineProperty(this, "connection", {
             enumerable: true,
             configurable: true,
@@ -196,6 +211,7 @@ export class ChatGoogleBase extends BaseChatModel {
         copyAndValidateModelParamsInto(fields, this);
         this.safetyHandler =
             fields?.safetyHandler ?? new DefaultGeminiSafetyHandler();
+        this.streamUsage = fields?.streamUsage ?? this.streamUsage;
         const client = this.buildClient(fields);
         this.buildConnection(fields ?? {}, client);
     }
@@ -257,11 +273,22 @@ export class ChatGoogleBase extends BaseChatModel {
         const response = await this.streamedConnection.request(_messages, parameters, options);
         // 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();
+            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
                 ? safeResponseToChatGeneration({ data: output }, this.safetyHandler)
                 : new ChatGenerationChunk({
@@ -269,6 +296,7 @@ export class ChatGoogleBase extends BaseChatModel {
                     generationInfo: { finishReason: "stop" },
                     message: new AIMessageChunk({
                         content: "",
+                        usage_metadata: usageMetadata,
                     }),
                 });
             yield chunk;

package/dist/types.d.ts

@@ -95,6 +95,12 @@ export interface GoogleAIModelRequestParams extends GoogleAIModelParams {
 export interface GoogleAIBaseLLMInput<AuthOptions> extends BaseLLMParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams, GoogleAISafetyParams {
 }
 export interface GoogleAIBaseLanguageModelCallOptions extends BaseLanguageModelCallOptions, GoogleAIModelRequestParams, GoogleAISafetyParams {
+    /**
+     * Whether or not to include usage data, like token counts
+     * in the streamed response chunks.
+     * @default true
+     */
+    streamUsage?: boolean;
 }
 /**
  * Input to LLM class.

package/dist/utils/gemini.cjs

@@ -482,12 +482,22 @@ function responseToChatGenerations(response) {
             id: toolCall.id,
             index: i,
         }));
+        let usageMetadata;
+        if ("usageMetadata" in response.data) {
+            usageMetadata = {
+                input_tokens: response.data.usageMetadata.promptTokenCount,
+                output_tokens: response.data.usageMetadata
+                    .candidatesTokenCount,
+                total_tokens: response.data.usageMetadata.totalTokenCount,
+            };
+        }
         ret = [
             new outputs_1.ChatGenerationChunk({
                 message: new messages_1.AIMessageChunk({
                     content: combinedContent,
                     additional_kwargs: ret[ret.length - 1]?.message.additional_kwargs,
                     tool_call_chunks: toolCallChunks,
+                    usage_metadata: usageMetadata,
                 }),
                 text: combinedText,
                 generationInfo: ret[ret.length - 1].generationInfo,

package/dist/utils/gemini.js

@@ -461,12 +461,22 @@ export function responseToChatGenerations(response) {
             id: toolCall.id,
             index: i,
         }));
+        let usageMetadata;
+        if ("usageMetadata" in response.data) {
+            usageMetadata = {
+                input_tokens: response.data.usageMetadata.promptTokenCount,
+                output_tokens: response.data.usageMetadata
+                    .candidatesTokenCount,
+                total_tokens: response.data.usageMetadata.totalTokenCount,
+            };
+        }
         ret = [
             new ChatGenerationChunk({
                 message: new AIMessageChunk({
                     content: combinedContent,
                     additional_kwargs: ret[ret.length - 1]?.message.additional_kwargs,
                     tool_call_chunks: toolCallChunks,
+                    usage_metadata: usageMetadata,
                 }),
                 text: combinedText,
                 generationInfo: ret[ret.length - 1].generationInfo,

package/dist/utils/zod_to_gemini_parameters.cjs

@@ -1,40 +1,51 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-unused-vars */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zodToGeminiParameters = void 0;
+exports.jsonSchemaToGeminiParameters = exports.zodToGeminiParameters = exports.removeAdditionalProperties = void 0;
 const zod_to_json_schema_1 = require("zod-to-json-schema");
-function removeAdditionalProperties(schema) {
-    const updatedSchema = { ...schema };
-    if (Object.hasOwn(updatedSchema, "additionalProperties")) {
-        delete updatedSchema.additionalProperties;
-    }
-    if (updatedSchema.properties) {
-        const keys = Object.keys(updatedSchema.properties);
-        removeProperties(updatedSchema.properties, keys, 0);
-    }
-    if (Object.hasOwn(updatedSchema, "items") && updatedSchema.items) {
-        updatedSchema.items = removeAdditionalProperties(updatedSchema.items);
-    }
-    return updatedSchema;
-}
-function removeProperties(properties, keys, index) {
-    if (index >= keys.length) {
-        return;
+function removeAdditionalProperties(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+obj) {
+    if (typeof obj === "object" && obj !== null) {
+        const newObj = { ...obj };
+        if ("additionalProperties" in newObj &&
+            typeof newObj.additionalProperties === "boolean") {
+            delete newObj.additionalProperties;
+        }
+        for (const key in newObj) {
+            if (key in newObj) {
+                if (Array.isArray(newObj[key])) {
+                    newObj[key] = newObj[key].map(removeAdditionalProperties);
+                }
+                else if (typeof newObj[key] === "object" && newObj[key] !== null) {
+                    newObj[key] = removeAdditionalProperties(newObj[key]);
+                }
+            }
+        }
+        return newObj;
     }
-    const key = keys[index];
-    // eslint-disable-next-line no-param-reassign
-    properties[key] = removeAdditionalProperties(properties[key]);
-    removeProperties(properties, keys, index + 1);
+    return obj;
 }
+exports.removeAdditionalProperties = removeAdditionalProperties;
 function zodToGeminiParameters(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 zodObj) {
     // Gemini doesn't accept either the $schema or additionalProperties
     // attributes, so we need to explicitly remove them.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    // const jsonSchema = zodToJsonSchema(zodObj) as any;
     const jsonSchema = removeAdditionalProperties((0, zod_to_json_schema_1.zodToJsonSchema)(zodObj));
     const { $schema, ...rest } = jsonSchema;
     return rest;
 }
 exports.zodToGeminiParameters = zodToGeminiParameters;
+function jsonSchemaToGeminiParameters(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    // Gemini doesn't accept either the $schema or additionalProperties
+    // attributes, so we need to explicitly remove them.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const jsonSchema = removeAdditionalProperties(schema);
+    const { $schema, ...rest } = jsonSchema;
+    return rest;
+}
+exports.jsonSchemaToGeminiParameters = jsonSchemaToGeminiParameters;

package/dist/utils/zod_to_gemini_parameters.d.ts

@@ -1,3 +1,5 @@
 import type { z } from "zod";
-import { GeminiFunctionSchema } from "../types.js";
+import { GeminiFunctionSchema, GeminiJsonSchema } from "../types.js";
+export declare function removeAdditionalProperties(obj: Record<string, any>): GeminiJsonSchema;
 export declare function zodToGeminiParameters(zodObj: z.ZodType<any>): GeminiFunctionSchema;
+export declare function jsonSchemaToGeminiParameters(schema: Record<string, any>): GeminiFunctionSchema;

package/dist/utils/zod_to_gemini_parameters.js

@@ -1,27 +1,27 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { zodToJsonSchema } from "zod-to-json-schema";
-function removeAdditionalProperties(schema) {
-    const updatedSchema = { ...schema };
-    if (Object.hasOwn(updatedSchema, "additionalProperties")) {
-        delete updatedSchema.additionalProperties;
-    }
-    if (updatedSchema.properties) {
-        const keys = Object.keys(updatedSchema.properties);
-        removeProperties(updatedSchema.properties, keys, 0);
-    }
-    if (Object.hasOwn(updatedSchema, "items") && updatedSchema.items) {
-        updatedSchema.items = removeAdditionalProperties(updatedSchema.items);
-    }
-    return updatedSchema;
-}
-function removeProperties(properties, keys, index) {
-    if (index >= keys.length) {
-        return;
+export function removeAdditionalProperties(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+obj) {
+    if (typeof obj === "object" && obj !== null) {
+        const newObj = { ...obj };
+        if ("additionalProperties" in newObj &&
+            typeof newObj.additionalProperties === "boolean") {
+            delete newObj.additionalProperties;
+        }
+        for (const key in newObj) {
+            if (key in newObj) {
+                if (Array.isArray(newObj[key])) {
+                    newObj[key] = newObj[key].map(removeAdditionalProperties);
+                }
+                else if (typeof newObj[key] === "object" && newObj[key] !== null) {
+                    newObj[key] = removeAdditionalProperties(newObj[key]);
+                }
+            }
+        }
+        return newObj;
     }
-    const key = keys[index];
-    // eslint-disable-next-line no-param-reassign
-    properties[key] = removeAdditionalProperties(properties[key]);
-    removeProperties(properties, keys, index + 1);
+    return obj;
 }
 export function zodToGeminiParameters(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -29,8 +29,17 @@ zodObj) {
     // Gemini doesn't accept either the $schema or additionalProperties
     // attributes, so we need to explicitly remove them.
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    // const jsonSchema = zodToJsonSchema(zodObj) as any;
     const jsonSchema = removeAdditionalProperties(zodToJsonSchema(zodObj));
     const { $schema, ...rest } = jsonSchema;
     return rest;
 }
+export function jsonSchemaToGeminiParameters(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schema) {
+    // Gemini doesn't accept either the $schema or additionalProperties
+    // attributes, so we need to explicitly remove them.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const jsonSchema = removeAdditionalProperties(schema);
+    const { $schema, ...rest } = jsonSchema;
+    return rest;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/google-common",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "Core types and classes for Google services.",
   "type": "module",
   "engines": {
@@ -40,7 +40,7 @@
   "author": "LangChain",
   "license": "MIT",
   "dependencies": {
-    "@langchain/core": ">0.1.56 <0.3.0",
+    "@langchain/core": ">=0.2.9 <0.3.0",
     "uuid": "^9.0.0",
     "zod-to-json-schema": "^3.22.4"
   },