@langchain/google-common 0.2.5 → 0.2.7

package/dist/connection.cjs

@@ -114,17 +114,17 @@ class GoogleHostConnection extends GoogleConnection {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "apiVersion", {
+        Object.defineProperty(this, "_apiVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "v1"
+            value: void 0
         });
         this.caller = caller;
         this.platformType = fields?.platformType;
         this._endpoint = fields?.endpoint;
         this._location = fields?.location;
-        this.apiVersion = fields?.apiVersion ?? this.apiVersion;
+        this._apiVersion = fields?.apiVersion;
         this.client = client;
     }
     get platform() {
@@ -133,6 +133,12 @@ class GoogleHostConnection extends GoogleConnection {
     get computedPlatformType() {
         return "gcp";
     }
+    get computedApiVersion() {
+        return "v1";
+    }
+    get apiVersion() {
+        return this._apiVersion ?? this.computedApiVersion;
+    }
     get location() {
         return this._location ?? this.computedLocation;
     }
@@ -238,6 +244,14 @@ class GoogleAIConnection extends GoogleHostConnection {
             return "gcp";
         }
     }
+    get computedApiVersion() {
+        switch (this.platform) {
+            case "gai":
+                return "v1beta";
+            default:
+                return "v1";
+        }
+    }
     get computedLocation() {
         switch (this.apiName) {
             case "google":

package/dist/connection.d.ts

@@ -25,10 +25,12 @@ export declare abstract class GoogleHostConnection<CallOptions extends AsyncCall
     platformType: GooglePlatformType | undefined;
     _endpoint: string | undefined;
     _location: string | undefined;
-    apiVersion: string;
+    _apiVersion: string | undefined;
     constructor(fields: GoogleConnectionParams<AuthOptions> | undefined, caller: AsyncCaller, client: GoogleAbstractedClient, streaming?: boolean);
     get platform(): GooglePlatformType;
     get computedPlatformType(): GooglePlatformType;
+    get computedApiVersion(): string;
+    get apiVersion(): string;
     get location(): string;
     get computedLocation(): string;
     get endpoint(): string;
@@ -52,6 +54,7 @@ export declare abstract class GoogleAIConnection<CallOptions extends AsyncCaller
     get api(): GoogleAIAPI;
     get isApiKey(): boolean;
     get computedPlatformType(): GooglePlatformType;
+    get computedApiVersion(): string;
     get computedLocation(): string;
     abstract buildUrlMethod(): Promise<string>;
     buildUrlGenerativeLanguage(): Promise<string>;

package/dist/connection.js

@@ -110,17 +110,17 @@ export class GoogleHostConnection extends GoogleConnection {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "apiVersion", {
+        Object.defineProperty(this, "_apiVersion", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "v1"
+            value: void 0
         });
         this.caller = caller;
         this.platformType = fields?.platformType;
         this._endpoint = fields?.endpoint;
         this._location = fields?.location;
-        this.apiVersion = fields?.apiVersion ?? this.apiVersion;
+        this._apiVersion = fields?.apiVersion;
         this.client = client;
     }
     get platform() {
@@ -129,6 +129,12 @@ export class GoogleHostConnection extends GoogleConnection {
     get computedPlatformType() {
         return "gcp";
     }
+    get computedApiVersion() {
+        return "v1";
+    }
+    get apiVersion() {
+        return this._apiVersion ?? this.computedApiVersion;
+    }
     get location() {
         return this._location ?? this.computedLocation;
     }
@@ -232,6 +238,14 @@ export class GoogleAIConnection extends GoogleHostConnection {
             return "gcp";
         }
     }
+    get computedApiVersion() {
+        switch (this.platform) {
+            case "gai":
+                return "v1beta";
+            default:
+                return "v1";
+        }
+    }
     get computedLocation() {
         switch (this.apiName) {
             case "google":

package/dist/experimental/media.cjs

@@ -328,14 +328,8 @@ class AIStudioMediaBlob extends media_core_js_1.MediaBlob {
 }
 exports.AIStudioMediaBlob = AIStudioMediaBlob;
 class AIStudioFileUploadConnection extends GoogleMultipartUploadConnection {
-    constructor() {
-        super(...arguments);
-        Object.defineProperty(this, "apiVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "v1beta"
-        });
+    get computedApiVersion() {
+        return "v1beta";
     }
     async buildUrl() {
         return `https://generativelanguage.googleapis.com/upload/${this.apiVersion}/files`;
@@ -357,15 +351,12 @@ class AIStudioFileDownloadConnection extends GoogleDownloadConnection {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "apiVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "v1beta"
-        });
         this.method = fields.method;
         this.name = fields.name;
     }
+    get computedApiVersion() {
+        return "v1beta";
+    }
     buildMethod() {
         return this.method;
     }

package/dist/experimental/media.d.ts

@@ -166,7 +166,7 @@ export interface AIStudioFileConnectionParams {
 export interface AIStudioFileUploadConnectionParams<AuthOptions> extends GoogleUploadConnectionParams<AuthOptions>, AIStudioFileConnectionParams {
 }
 export declare class AIStudioFileUploadConnection<AuthOptions> extends GoogleMultipartUploadConnection<AsyncCallerCallOptions, AIStudioFileSaveResponse, AuthOptions> {
-    apiVersion: string;
+    get computedApiVersion(): string;
     buildUrl(): Promise<string>;
 }
 export interface AIStudioFileDownloadConnectionParams<AuthOptions> extends AIStudioFileConnectionParams, GoogleConnectionParams<AuthOptions> {
@@ -176,8 +176,8 @@ export interface AIStudioFileDownloadConnectionParams<AuthOptions> extends AIStu
 export declare class AIStudioFileDownloadConnection<ResponseType extends GoogleResponse, AuthOptions> extends GoogleDownloadConnection<AsyncCallerCallOptions, ResponseType, AuthOptions> {
     method: GoogleAbstractedClientOpsMethod;
     name: string;
-    apiVersion: string;
     constructor(fields: AIStudioFileDownloadConnectionParams<AuthOptions>, caller: AsyncCaller, client: GoogleAbstractedClient);
+    get computedApiVersion(): string;
     buildMethod(): GoogleAbstractedClientOpsMethod;
     buildUrl(): Promise<string>;
 }

package/dist/experimental/media.js

@@ -315,14 +315,8 @@ export class AIStudioMediaBlob extends MediaBlob {
     }
 }
 export class AIStudioFileUploadConnection extends GoogleMultipartUploadConnection {
-    constructor() {
-        super(...arguments);
-        Object.defineProperty(this, "apiVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "v1beta"
-        });
+    get computedApiVersion() {
+        return "v1beta";
     }
     async buildUrl() {
         return `https://generativelanguage.googleapis.com/upload/${this.apiVersion}/files`;
@@ -343,15 +337,12 @@ export class AIStudioFileDownloadConnection extends GoogleDownloadConnection {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "apiVersion", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "v1beta"
-        });
         this.method = fields.method;
         this.name = fields.name;
     }
+    get computedApiVersion() {
+        return "v1beta";
+    }
     buildMethod() {
         return this.method;
     }

package/dist/types.d.ts

@@ -451,10 +451,28 @@ interface GeminiResponsePromptFeedback {
     blockReason?: string;
     safetyRatings: GeminiSafetyRating[];
 }
+export type ModalityEnum = "TEXT" | "IMAGE" | "VIDEO" | "AUDIO" | "DOCUMENT" | string;
+export interface ModalityTokenCount {
+    modality: ModalityEnum;
+    tokenCount: number;
+}
+export interface GenerateContentResponseUsageMetadata {
+    promptTokenCount: number;
+    toolUsePromptTokenCount: number;
+    cachedContentTokenCount: number;
+    thoughtsTokenCount: number;
+    candidatesTokenCount: number;
+    totalTokenCount: number;
+    promptTokensDetails: ModalityTokenCount[];
+    toolUsePromptTokensDetails: ModalityTokenCount[];
+    cacheTokensDetails: ModalityTokenCount[];
+    candidatesTokensDetails: ModalityTokenCount[];
+    [key: string]: unknown;
+}
 export interface GenerateContentResponseData {
     candidates: GeminiResponseCandidate[];
     promptFeedback: GeminiResponsePromptFeedback;
-    usageMetadata: Record<string, unknown>;
+    usageMetadata: GenerateContentResponseUsageMetadata;
 }
 export type GoogleLLMModelFamily = null | "palm" | "gemini" | "gemma";
 export type VertexModelFamily = GoogleLLMModelFamily | "claude";

package/dist/utils/gemini.cjs

@@ -639,6 +639,42 @@ function getGeminiAPI(config) {
             content,
         };
     }
+    function addModalityCounts(modalityTokenCounts, details) {
+        modalityTokenCounts?.forEach((modalityTokenCount) => {
+            const { modality, tokenCount } = modalityTokenCount;
+            const modalityLc = modality.toLowerCase();
+            const currentCount = details[modalityLc] ?? 0;
+            // eslint-disable-next-line no-param-reassign
+            details[modalityLc] = currentCount + tokenCount;
+        });
+    }
+    function responseToUsageMetadata(response) {
+        if ("usageMetadata" in response.data) {
+            const data = response?.data;
+            const usageMetadata = data?.usageMetadata;
+            const input_tokens = usageMetadata.promptTokenCount ?? 0;
+            const candidatesTokenCount = usageMetadata.candidatesTokenCount ?? 0;
+            const thoughtsTokenCount = usageMetadata.thoughtsTokenCount ?? 0;
+            const output_tokens = candidatesTokenCount + thoughtsTokenCount;
+            const total_tokens = usageMetadata.totalTokenCount ?? input_tokens + output_tokens;
+            const input_token_details = {};
+            addModalityCounts(usageMetadata.promptTokensDetails, input_token_details);
+            const output_token_details = {};
+            addModalityCounts(usageMetadata?.candidatesTokensDetails, output_token_details);
+            if (typeof usageMetadata?.thoughtsTokenCount === "number") {
+                output_token_details.reasoning = usageMetadata.thoughtsTokenCount;
+            }
+            const ret = {
+                input_tokens,
+                output_tokens,
+                total_tokens,
+                input_token_details,
+                output_token_details,
+            };
+            return ret;
+        }
+        return undefined;
+    }
     function responseToGenerationInfo(response) {
         const data = 
         // eslint-disable-next-line no-nested-ternary
@@ -651,12 +687,9 @@ function getGeminiAPI(config) {
         if (!data) {
             return {};
         }
-        return {
-            usage_metadata: {
-                prompt_token_count: data.usageMetadata?.promptTokenCount,
-                candidates_token_count: data.usageMetadata?.candidatesTokenCount,
-                total_token_count: data.usageMetadata?.totalTokenCount,
-            },
+        const finish_reason = data.candidates[0]?.finishReason;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const ret = {
             safety_ratings: data.candidates[0]?.safetyRatings?.map((rating) => ({
                 category: rating.category,
                 probability: rating.probability,
@@ -666,11 +699,17 @@ function getGeminiAPI(config) {
             })),
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
-            finish_reason: data.candidates[0]?.finishReason,
+            finish_reason,
             finish_message: data.candidates[0]?.finishMessage,
             avgLogprobs: data.candidates[0]?.avgLogprobs,
             logprobs: candidateToLogprobs(data.candidates[0]),
         };
+        // Only add the usage_metadata on the last chunk
+        // sent while streaming (see issue 8102).
+        if (typeof finish_reason === "string") {
+            ret.usage_metadata = responseToUsageMetadata(response);
+        }
+        return ret;
     }
     function responseToChatGeneration(response) {
         return new outputs_1.ChatGenerationChunk({
@@ -845,15 +884,7 @@ function getGeminiAPI(config) {
         const kwargs = combineAdditionalKwargs(gen.content);
         const lastContent = gen.content[gen.content.length - 1];
         // Add usage metadata
-        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,
-            };
-        }
+        const usage_metadata = responseToUsageMetadata(response);
         // Add thinking / reasoning
         // if (gen.reasoning && gen.reasoning.length > 0) {
         //   kwargs.reasoning_content = combineContent(gen.reasoning, true);
@@ -862,7 +893,7 @@ function getGeminiAPI(config) {
         const message = new messages_1.AIMessageChunk({
             content: combinedContent,
             additional_kwargs: kwargs,
-            usage_metadata: usageMetadata,
+            usage_metadata,
             tool_calls: combinedToolCalls.tool_calls,
             invalid_tool_calls: combinedToolCalls.invalid_tool_calls,
         });
@@ -1057,10 +1088,12 @@ function getGeminiAPI(config) {
             }
         }
         // Add thinking configuration if explicitly set
-        if (typeof parameters.maxReasoningTokens !== "undefined") {
+        if (typeof parameters.maxReasoningTokens !== "undefined" &&
+            parameters.maxReasoningTokens !== 0) {
             ret.thinkingConfig = {
                 thinkingBudget: parameters.maxReasoningTokens,
-                includeThoughts: true,
+                // TODO: Expose this configuration to the user once google fully supports it
+                includeThoughts: false,
             };
         }
         // Remove any undefined properties, so we don't send them

package/dist/utils/gemini.js

@@ -634,6 +634,42 @@ export function getGeminiAPI(config) {
             content,
         };
     }
+    function addModalityCounts(modalityTokenCounts, details) {
+        modalityTokenCounts?.forEach((modalityTokenCount) => {
+            const { modality, tokenCount } = modalityTokenCount;
+            const modalityLc = modality.toLowerCase();
+            const currentCount = details[modalityLc] ?? 0;
+            // eslint-disable-next-line no-param-reassign
+            details[modalityLc] = currentCount + tokenCount;
+        });
+    }
+    function responseToUsageMetadata(response) {
+        if ("usageMetadata" in response.data) {
+            const data = response?.data;
+            const usageMetadata = data?.usageMetadata;
+            const input_tokens = usageMetadata.promptTokenCount ?? 0;
+            const candidatesTokenCount = usageMetadata.candidatesTokenCount ?? 0;
+            const thoughtsTokenCount = usageMetadata.thoughtsTokenCount ?? 0;
+            const output_tokens = candidatesTokenCount + thoughtsTokenCount;
+            const total_tokens = usageMetadata.totalTokenCount ?? input_tokens + output_tokens;
+            const input_token_details = {};
+            addModalityCounts(usageMetadata.promptTokensDetails, input_token_details);
+            const output_token_details = {};
+            addModalityCounts(usageMetadata?.candidatesTokensDetails, output_token_details);
+            if (typeof usageMetadata?.thoughtsTokenCount === "number") {
+                output_token_details.reasoning = usageMetadata.thoughtsTokenCount;
+            }
+            const ret = {
+                input_tokens,
+                output_tokens,
+                total_tokens,
+                input_token_details,
+                output_token_details,
+            };
+            return ret;
+        }
+        return undefined;
+    }
     function responseToGenerationInfo(response) {
         const data = 
         // eslint-disable-next-line no-nested-ternary
@@ -646,12 +682,9 @@ export function getGeminiAPI(config) {
         if (!data) {
             return {};
         }
-        return {
-            usage_metadata: {
-                prompt_token_count: data.usageMetadata?.promptTokenCount,
-                candidates_token_count: data.usageMetadata?.candidatesTokenCount,
-                total_token_count: data.usageMetadata?.totalTokenCount,
-            },
+        const finish_reason = data.candidates[0]?.finishReason;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const ret = {
             safety_ratings: data.candidates[0]?.safetyRatings?.map((rating) => ({
                 category: rating.category,
                 probability: rating.probability,
@@ -661,11 +694,17 @@ export function getGeminiAPI(config) {
             })),
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
-            finish_reason: data.candidates[0]?.finishReason,
+            finish_reason,
             finish_message: data.candidates[0]?.finishMessage,
             avgLogprobs: data.candidates[0]?.avgLogprobs,
             logprobs: candidateToLogprobs(data.candidates[0]),
         };
+        // Only add the usage_metadata on the last chunk
+        // sent while streaming (see issue 8102).
+        if (typeof finish_reason === "string") {
+            ret.usage_metadata = responseToUsageMetadata(response);
+        }
+        return ret;
     }
     function responseToChatGeneration(response) {
         return new ChatGenerationChunk({
@@ -840,15 +879,7 @@ export function getGeminiAPI(config) {
         const kwargs = combineAdditionalKwargs(gen.content);
         const lastContent = gen.content[gen.content.length - 1];
         // Add usage metadata
-        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,
-            };
-        }
+        const usage_metadata = responseToUsageMetadata(response);
         // Add thinking / reasoning
         // if (gen.reasoning && gen.reasoning.length > 0) {
         //   kwargs.reasoning_content = combineContent(gen.reasoning, true);
@@ -857,7 +888,7 @@ export function getGeminiAPI(config) {
         const message = new AIMessageChunk({
             content: combinedContent,
             additional_kwargs: kwargs,
-            usage_metadata: usageMetadata,
+            usage_metadata,
             tool_calls: combinedToolCalls.tool_calls,
             invalid_tool_calls: combinedToolCalls.invalid_tool_calls,
         });
@@ -1052,10 +1083,12 @@ export function getGeminiAPI(config) {
             }
         }
         // Add thinking configuration if explicitly set
-        if (typeof parameters.maxReasoningTokens !== "undefined") {
+        if (typeof parameters.maxReasoningTokens !== "undefined" &&
+            parameters.maxReasoningTokens !== 0) {
             ret.thinkingConfig = {
                 thinkingBudget: parameters.maxReasoningTokens,
-                includeThoughts: true,
+                // TODO: Expose this configuration to the user once google fully supports it
+                includeThoughts: false,
             };
         }
         // Remove any undefined properties, so we don't send them

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@langchain/google-common",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "Core types and classes for Google services.",
   "type": "module",
   "engines": {
@@ -36,11 +36,11 @@
     "zod-to-json-schema": "^3.22.4"
   },
   "peerDependencies": {
-    "@langchain/core": ">=0.3.48 <0.4.0"
+    "@langchain/core": ">=0.3.55 <0.4.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
-    "@langchain/core": "0.3.48",
+    "@langchain/core": "0.3.55",
     "@langchain/scripts": ">=0.1.0 <0.2.0",
     "@swc/core": "^1.3.90",
     "@swc/jest": "^0.2.29",