@langchain/google-common 0.2.1 → 0.2.3

package/dist/chat_models.cjs

@@ -51,6 +51,11 @@ class ChatConnection extends connection_js_1.AbstractGoogleLLMConnection {
             // 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() {
@@ -187,6 +192,12 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
             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,

package/dist/chat_models.d.ts

@@ -10,7 +10,7 @@ import { AsyncCaller } from "@langchain/core/utils/async_caller";
 import { GoogleAIBaseLLMInput, GoogleAIModelParams, GoogleAISafetySetting, GoogleConnectionParams, GooglePlatformType, GoogleAIBaseLanguageModelCallOptions, GoogleAIAPI, GoogleAIAPIParams, GoogleSearchToolSetting } from "./types.js";
 import { AbstractGoogleLLMConnection } from "./connection.js";
 import { GoogleAbstractedClient } from "./auth.js";
-import type { GoogleBaseLLMInput, GoogleAISafetyHandler, GoogleAISafetyParams, GoogleAIToolType, GeminiAPIConfig } from "./types.js";
+import type { GoogleBaseLLMInput, GoogleAISafetyHandler, GoogleAISafetyParams, GoogleAIToolType, GeminiAPIConfig, GoogleAIModelModality } from "./types.js";
 export declare class ChatConnection<AuthOptions> extends AbstractGoogleLLMConnection<BaseMessage[], AuthOptions> {
     convertSystemMessageToHumanContent: boolean | undefined;
     constructor(fields: GoogleAIBaseLLMInput<AuthOptions> | undefined, caller: AsyncCaller, client: GoogleAbstractedClient, streaming: boolean);
@@ -47,6 +47,7 @@ export declare abstract class ChatGoogleBase<AuthOptions> extends BaseChatModel<
     logprobs: boolean;
     topLogprobs: number;
     safetySettings: GoogleAISafetySetting[];
+    responseModalities?: GoogleAIModelModality[];
     convertSystemMessageToHumanContent: boolean | undefined;
     safetyHandler: GoogleAISafetyHandler;
     streamUsage: boolean;

package/dist/chat_models.js

@@ -48,6 +48,11 @@ export class ChatConnection extends AbstractGoogleLLMConnection {
             // 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() {
@@ -183,6 +188,12 @@ export class ChatGoogleBase extends BaseChatModel {
             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,

package/dist/connection.cjs

@@ -216,6 +216,7 @@ class GoogleAIConnection extends GoogleHostConnection {
     get api() {
         switch (this.apiName) {
             case "google":
+            case "gemma": // TODO: Is this true?
                 return (0, index_js_1.getGeminiAPI)(this.apiConfig);
             case "anthropic":
                 return (0, anthropic_js_1.getAnthropicAPI)(this.apiConfig);
@@ -319,6 +320,7 @@ class AbstractGoogleLLMConnection extends GoogleAIConnection {
     async buildUrlMethod() {
         switch (this.modelFamily) {
             case "gemini":
+            case "gemma": // TODO: Is this true?
                 return this.buildUrlMethodGemini();
             case "claude":
                 return this.buildUrlMethodClaude();

package/dist/connection.js

@@ -210,6 +210,7 @@ export class GoogleAIConnection extends GoogleHostConnection {
     get api() {
         switch (this.apiName) {
             case "google":
+            case "gemma": // TODO: Is this true?
                 return getGeminiAPI(this.apiConfig);
             case "anthropic":
                 return getAnthropicAPI(this.apiConfig);
@@ -312,6 +313,7 @@ export class AbstractGoogleLLMConnection extends GoogleAIConnection {
     async buildUrlMethod() {
         switch (this.modelFamily) {
             case "gemini":
+            case "gemma": // TODO: Is this true?
                 return this.buildUrlMethodGemini();
             case "claude":
                 return this.buildUrlMethodClaude();

package/dist/types.d.ts

@@ -84,6 +84,7 @@ export interface GoogleAISafetySetting {
     method?: GoogleAISafetyMethod | string;
 }
 export type GoogleAIResponseMimeType = "text/plain" | "application/json";
+export type GoogleAIModelModality = "TEXT" | "IMAGE" | "AUDIO" | string;
 export interface GoogleAIModelParams {
     /** Model to use */
     model?: string;
@@ -177,6 +178,10 @@ export interface GoogleAIModelParams {
      * logprobs must be set to true if this parameter is used.
      */
     topLogprobs?: number;
+    /**
+     * The modalities of the response.
+     */
+    responseModalities?: GoogleAIModelModality[];
 }
 export type GoogleAIToolType = BindToolsInput | GeminiTool;
 /**
@@ -202,6 +207,16 @@ export interface GoogleAIModelRequestParams extends GoogleAIModelParams {
      * If empty, any one of the provided functions are called.
      */
     allowed_function_names?: string[];
+    /**
+     * Used to specify a previously created context cache to use with generation.
+     * For Vertex, this should be of the form:
+     * "projects/PROJECT_NUMBER/locations/LOCATION/cachedContents/CACHE_ID",
+     *
+     * See these guides for more information on how to use context caching:
+     * https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-create
+     * https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-use
+     */
+    cachedContent?: string;
 }
 export interface GoogleAIBaseLLMInput<AuthOptions> extends BaseLLMParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams, GoogleAISafetyParams, GoogleAIAPIParams {
 }
@@ -382,6 +397,7 @@ export interface GeminiGenerationConfig {
     responseMimeType?: GoogleAIResponseMimeType;
     responseLogprobs?: boolean;
     logprobs?: number;
+    responseModalities?: GoogleAIModelModality[];
 }
 export interface GeminiRequest {
     contents?: GeminiContent[];
@@ -395,6 +411,7 @@ export interface GeminiRequest {
     };
     safetySettings?: GeminiSafetySetting[];
     generationConfig?: GeminiGenerationConfig;
+    cachedContent?: string;
 }
 export interface GeminiResponseCandidate {
     content: {
@@ -409,6 +426,7 @@ export interface GeminiResponseCandidate {
     groundingMetadata?: GeminiGroundingMetadata;
     avgLogprobs?: number;
     logprobsResult: GeminiLogprobsResult;
+    finishMessage?: string;
 }
 interface GeminiResponsePromptFeedback {
     blockReason?: string;
@@ -419,7 +437,7 @@ export interface GenerateContentResponseData {
     promptFeedback: GeminiResponsePromptFeedback;
     usageMetadata: Record<string, unknown>;
 }
-export type GoogleLLMModelFamily = null | "palm" | "gemini";
+export type GoogleLLMModelFamily = null | "palm" | "gemini" | "gemma";
 export type VertexModelFamily = GoogleLLMModelFamily | "claude";
 export type GoogleLLMResponseData = JsonStream | GenerateContentResponseData | GenerateContentResponseData[];
 export interface GoogleLLMResponse extends GoogleResponse {

package/dist/utils/common.cjs

@@ -128,6 +128,10 @@ function copyAIModelParamsInto(params, options, target) {
         options?.responseMimeType ??
             params?.responseMimeType ??
             target?.responseMimeType;
+    ret.responseModalities =
+        options?.responseModalities ??
+            params?.responseModalities ??
+            target?.responseModalities;
     ret.streaming = options?.streaming ?? params?.streaming ?? target?.streaming;
     const toolChoice = processToolChoice(options?.tool_choice, options?.allowed_function_names);
     if (toolChoice) {
@@ -139,6 +143,9 @@ function copyAIModelParamsInto(params, options, target) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         ret.tools = convertToGeminiTools(tools);
     }
+    if (options?.cachedContent) {
+        ret.cachedContent = options.cachedContent;
+    }
     return ret;
 }
 exports.copyAIModelParamsInto = copyAIModelParamsInto;
@@ -149,6 +156,9 @@ function modelToFamily(modelName) {
     else if ((0, gemini_js_1.isModelGemini)(modelName)) {
         return "gemini";
     }
+    else if ((0, gemini_js_1.isModelGemma)(modelName)) {
+        return "gemma";
+    }
     else if ((0, anthropic_js_1.isModelClaude)(modelName)) {
         return "claude";
     }
@@ -161,6 +171,7 @@ function modelToPublisher(modelName) {
     const family = modelToFamily(modelName);
     switch (family) {
         case "gemini":
+        case "gemma":
         case "palm":
             return "google";
         case "claude":
@@ -175,6 +186,7 @@ function validateModelParams(params) {
     const model = testParams.model ?? testParams.modelName;
     switch (modelToFamily(model)) {
         case "gemini":
+        case "gemma": // TODO: Are we sure?
             return (0, gemini_js_1.validateGeminiParams)(testParams);
         case "claude":
             return (0, anthropic_js_1.validateClaudeParams)(testParams);

package/dist/utils/common.js

@@ -1,6 +1,6 @@
 import { isOpenAITool } from "@langchain/core/language_models/base";
 import { isLangChainTool } from "@langchain/core/utils/function_calling";
-import { isModelGemini, validateGeminiParams } from "./gemini.js";
+import { isModelGemini, isModelGemma, validateGeminiParams } from "./gemini.js";
 import { GeminiToolAttributes, } from "../types.js";
 import { jsonSchemaToGeminiParameters, zodToGeminiParameters, } from "./zod_to_gemini_parameters.js";
 import { isModelClaude, validateClaudeParams } from "./anthropic.js";
@@ -123,6 +123,10 @@ export function copyAIModelParamsInto(params, options, target) {
         options?.responseMimeType ??
             params?.responseMimeType ??
             target?.responseMimeType;
+    ret.responseModalities =
+        options?.responseModalities ??
+            params?.responseModalities ??
+            target?.responseModalities;
     ret.streaming = options?.streaming ?? params?.streaming ?? target?.streaming;
     const toolChoice = processToolChoice(options?.tool_choice, options?.allowed_function_names);
     if (toolChoice) {
@@ -134,6 +138,9 @@ export function copyAIModelParamsInto(params, options, target) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         ret.tools = convertToGeminiTools(tools);
     }
+    if (options?.cachedContent) {
+        ret.cachedContent = options.cachedContent;
+    }
     return ret;
 }
 export function modelToFamily(modelName) {
@@ -143,6 +150,9 @@ export function modelToFamily(modelName) {
     else if (isModelGemini(modelName)) {
         return "gemini";
     }
+    else if (isModelGemma(modelName)) {
+        return "gemma";
+    }
     else if (isModelClaude(modelName)) {
         return "claude";
     }
@@ -154,6 +164,7 @@ export function modelToPublisher(modelName) {
     const family = modelToFamily(modelName);
     switch (family) {
         case "gemini":
+        case "gemma":
         case "palm":
             return "google";
         case "claude":
@@ -167,6 +178,7 @@ export function validateModelParams(params) {
     const model = testParams.model ?? testParams.modelName;
     switch (modelToFamily(model)) {
         case "gemini":
+        case "gemma": // TODO: Are we sure?
             return validateGeminiParams(testParams);
         case "claude":
             return validateClaudeParams(testParams);

package/dist/utils/gemini.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isModelGemini = exports.validateGeminiParams = exports.getGeminiAPI = exports.MessageGeminiSafetyHandler = exports.DefaultGeminiSafetyHandler = void 0;
+exports.isModelGemma = exports.isModelGemini = exports.validateGeminiParams = exports.getGeminiAPI = exports.MessageGeminiSafetyHandler = exports.DefaultGeminiSafetyHandler = void 0;
 const uuid_1 = require("uuid");
 const messages_1 = require("@langchain/core/messages");
 const outputs_1 = require("@langchain/core/outputs");
@@ -535,10 +535,17 @@ function getGeminiAPI(config) {
         };
     }
     function responseToGenerationInfo(response) {
-        if (!Array.isArray(response.data)) {
+        const data = 
+        // eslint-disable-next-line no-nested-ternary
+        Array.isArray(response.data) && response.data[0]
+            ? response.data[0]
+            : response.data &&
+                response.data.candidates
+                ? response.data
+                : undefined;
+        if (!data) {
             return {};
         }
-        const data = response.data[0];
         return {
             usage_metadata: {
                 prompt_token_count: data.usageMetadata?.promptTokenCount,
@@ -555,6 +562,7 @@ function getGeminiAPI(config) {
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
             finish_reason: data.candidates[0]?.finishReason,
+            finish_message: data.candidates[0]?.finishMessage,
             avgLogprobs: data.candidates[0]?.avgLogprobs,
             logprobs: candidateToLogprobs(data.candidates[0]),
         };
@@ -933,6 +941,7 @@ function getGeminiAPI(config) {
             maxOutputTokens: parameters.maxOutputTokens,
             stopSequences: parameters.stopSequences,
             responseMimeType: parameters.responseMimeType,
+            responseModalities: parameters.responseModalities,
         };
         // Add the logprobs if explicitly set
         if (typeof parameters.logprobs !== "undefined") {
@@ -1083,6 +1092,9 @@ function getGeminiAPI(config) {
             systemInstruction?.parts?.length) {
             ret.systemInstruction = systemInstruction;
         }
+        if (parameters.cachedContent) {
+            ret.cachedContent = parameters.cachedContent;
+        }
         return ret;
     }
     return {
@@ -1117,3 +1129,7 @@ function isModelGemini(modelName) {
     return modelName.toLowerCase().startsWith("gemini");
 }
 exports.isModelGemini = isModelGemini;
+function isModelGemma(modelName) {
+    return modelName.toLowerCase().startsWith("gemma");
+}
+exports.isModelGemma = isModelGemma;

package/dist/utils/gemini.d.ts

@@ -42,3 +42,4 @@ export declare class MessageGeminiSafetyHandler extends DefaultGeminiSafetyHandl
 export declare function getGeminiAPI(config?: GeminiAPIConfig): GoogleAIAPI;
 export declare function validateGeminiParams(params: GoogleAIModelParams): void;
 export declare function isModelGemini(modelName: string): boolean;
+export declare function isModelGemma(modelName: string): boolean;

package/dist/utils/gemini.js

@@ -530,10 +530,17 @@ export function getGeminiAPI(config) {
         };
     }
     function responseToGenerationInfo(response) {
-        if (!Array.isArray(response.data)) {
+        const data = 
+        // eslint-disable-next-line no-nested-ternary
+        Array.isArray(response.data) && response.data[0]
+            ? response.data[0]
+            : response.data &&
+                response.data.candidates
+                ? response.data
+                : undefined;
+        if (!data) {
             return {};
         }
-        const data = response.data[0];
         return {
             usage_metadata: {
                 prompt_token_count: data.usageMetadata?.promptTokenCount,
@@ -550,6 +557,7 @@ export function getGeminiAPI(config) {
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
             finish_reason: data.candidates[0]?.finishReason,
+            finish_message: data.candidates[0]?.finishMessage,
             avgLogprobs: data.candidates[0]?.avgLogprobs,
             logprobs: candidateToLogprobs(data.candidates[0]),
         };
@@ -928,6 +936,7 @@ export function getGeminiAPI(config) {
             maxOutputTokens: parameters.maxOutputTokens,
             stopSequences: parameters.stopSequences,
             responseMimeType: parameters.responseMimeType,
+            responseModalities: parameters.responseModalities,
         };
         // Add the logprobs if explicitly set
         if (typeof parameters.logprobs !== "undefined") {
@@ -1078,6 +1087,9 @@ export function getGeminiAPI(config) {
             systemInstruction?.parts?.length) {
             ret.systemInstruction = systemInstruction;
         }
+        if (parameters.cachedContent) {
+            ret.cachedContent = parameters.cachedContent;
+        }
         return ret;
     }
     return {
@@ -1109,3 +1121,6 @@ export function validateGeminiParams(params) {
 export function isModelGemini(modelName) {
     return modelName.toLowerCase().startsWith("gemini");
 }
+export function isModelGemma(modelName) {
+    return modelName.toLowerCase().startsWith("gemma");
+}

package/package.json

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