@langchain/google-common 0.0.10 → 0.0.11

package/dist/chat_models.cjs

@@ -15,10 +15,73 @@ const auth_js_1 = require("./auth.cjs");
 const failed_handler_js_1 = require("./utils/failed_handler.cjs");
 const zod_to_gemini_parameters_js_1 = require("./utils/zod_to_gemini_parameters.cjs");
 class ChatConnection extends connection_js_1.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;
+        }
+        return true;
+    }
     formatContents(input, _parameters) {
         return input
-            .map((msg, i) => (0, gemini_js_1.baseMessageToContent)(msg, input[i - 1]))
-            .reduce((acc, cur) => [...acc, ...cur]);
+            .map((msg, i) => (0, gemini_js_1.baseMessageToContent)(msg, input[i - 1], this.useSystemInstruction))
+            .reduce((acc, cur) => {
+            // Filter out the system content, since those don't belong
+            // in the actual content.
+            const hasNoSystem = cur.every((content) => content.role !== "system");
+            return hasNoSystem ? [...acc, ...cur] : acc;
+        }, []);
+    }
+    formatSystemInstruction(input, _parameters) {
+        if (!this.useSystemInstruction) {
+            return {};
+        }
+        let ret = {};
+        input.forEach((message, index) => {
+            if (message._getType() === "system") {
+                // For system types, we only want it if it is the first message,
+                // if it appears anywhere else, it should be an error.
+                if (index === 0) {
+                    // eslint-disable-next-line prefer-destructuring
+                    ret = (0, gemini_js_1.baseMessageToContent)(message, undefined, true)[0];
+                }
+                else {
+                    throw new Error("System messages are only permitted as the first passed message.");
+                }
+            }
+        });
+        return ret;
     }
 }
 function convertToGeminiTools(structuredTools) {
@@ -54,11 +117,12 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
             writable: true,
             value: true
         });
+        // Set based on modelName
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "gemini-pro"
+            value: void 0
         });
         Object.defineProperty(this, "modelName", {
             enumerable: true,
@@ -102,6 +166,13 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
             writable: true,
             value: []
         });
+        // 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,

package/dist/chat_models.d.ts

@@ -6,13 +6,19 @@ import { AIMessageChunk } from "@langchain/core/messages";
 import { BaseLanguageModelInput, StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
 import type { z } from "zod";
 import { Runnable, RunnableInterface } from "@langchain/core/runnables";
+import { AsyncCaller } from "@langchain/core/utils/async_caller";
 import { StructuredToolInterface } from "@langchain/core/tools";
 import { GoogleAIBaseLLMInput, GoogleAIModelParams, GoogleAISafetySetting, GoogleConnectionParams, GooglePlatformType, GeminiContent, GoogleAIBaseLanguageModelCallOptions } from "./types.js";
 import { AbstractGoogleLLMConnection } from "./connection.js";
 import { GoogleAbstractedClient } from "./auth.js";
 import type { GoogleBaseLLMInput, GoogleAISafetyHandler, GoogleAISafetyParams } from "./types.js";
 declare class ChatConnection<AuthOptions> extends AbstractGoogleLLMConnection<BaseMessage[], AuthOptions> {
+    convertSystemMessageToHumanContent: boolean | undefined;
+    constructor(fields: GoogleAIBaseLLMInput<AuthOptions> | undefined, caller: AsyncCaller, client: GoogleAbstractedClient, streaming: boolean);
+    get useSystemInstruction(): boolean;
+    get computeUseSystemInstruction(): boolean;
     formatContents(input: BaseMessage[], _parameters: GoogleAIModelParams): GeminiContent[];
+    formatSystemInstruction(input: BaseMessage[], _parameters: GoogleAIModelParams): GeminiContent;
 }
 /**
  * Input to chat model class.
@@ -33,6 +39,7 @@ export declare abstract class ChatGoogleBase<AuthOptions> extends BaseChatModel<
     topK: number;
     stopSequences: string[];
     safetySettings: GoogleAISafetySetting[];
+    convertSystemMessageToHumanContent: boolean | undefined;
     safetyHandler: GoogleAISafetyHandler;
     protected connection: ChatConnection<AuthOptions>;
     protected streamedConnection: ChatConnection<AuthOptions>;

package/dist/chat_models.js

@@ -12,10 +12,73 @@ import { ApiKeyGoogleAuth } from "./auth.js";
 import { ensureParams } from "./utils/failed_handler.js";
 import { zodToGeminiParameters } from "./utils/zod_to_gemini_parameters.js";
 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;
+        }
+        return true;
+    }
     formatContents(input, _parameters) {
         return input
-            .map((msg, i) => baseMessageToContent(msg, input[i - 1]))
-            .reduce((acc, cur) => [...acc, ...cur]);
+            .map((msg, i) => baseMessageToContent(msg, input[i - 1], this.useSystemInstruction))
+            .reduce((acc, cur) => {
+            // Filter out the system content, since those don't belong
+            // in the actual content.
+            const hasNoSystem = cur.every((content) => content.role !== "system");
+            return hasNoSystem ? [...acc, ...cur] : acc;
+        }, []);
+    }
+    formatSystemInstruction(input, _parameters) {
+        if (!this.useSystemInstruction) {
+            return {};
+        }
+        let ret = {};
+        input.forEach((message, index) => {
+            if (message._getType() === "system") {
+                // For system types, we only want it if it is the first message,
+                // if it appears anywhere else, it should be an error.
+                if (index === 0) {
+                    // eslint-disable-next-line prefer-destructuring
+                    ret = baseMessageToContent(message, undefined, true)[0];
+                }
+                else {
+                    throw new Error("System messages are only permitted as the first passed message.");
+                }
+            }
+        });
+        return ret;
     }
 }
 function convertToGeminiTools(structuredTools) {
@@ -51,11 +114,12 @@ export class ChatGoogleBase extends BaseChatModel {
             writable: true,
             value: true
         });
+        // Set based on modelName
         Object.defineProperty(this, "model", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: "gemini-pro"
+            value: void 0
         });
         Object.defineProperty(this, "modelName", {
             enumerable: true,
@@ -99,6 +163,13 @@ export class ChatGoogleBase extends BaseChatModel {
             writable: true,
             value: []
         });
+        // 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,

package/dist/connection.cjs

@@ -213,6 +213,9 @@ class AbstractGoogleLLMConnection extends GoogleAIConnection {
     formatSafetySettings(_input, parameters) {
         return parameters.safetySettings ?? [];
     }
+    formatSystemInstruction(_input, _parameters) {
+        return {};
+    }
     // Borrowed from the OpenAI invocation params test
     isStructuredToolArray(tools) {
         return (tools !== undefined &&
@@ -253,6 +256,7 @@ class AbstractGoogleLLMConnection extends GoogleAIConnection {
         const generationConfig = this.formatGenerationConfig(input, parameters);
         const tools = this.formatTools(input, parameters);
         const safetySettings = this.formatSafetySettings(input, parameters);
+        const systemInstruction = this.formatSystemInstruction(input, parameters);
         const ret = {
             contents,
             generationConfig,
@@ -263,6 +267,11 @@ class AbstractGoogleLLMConnection extends GoogleAIConnection {
         if (safetySettings && safetySettings.length) {
             ret.safetySettings = safetySettings;
         }
+        if (systemInstruction?.role &&
+            systemInstruction?.parts &&
+            systemInstruction?.parts?.length) {
+            ret.systemInstruction = systemInstruction;
+        }
         return ret;
     }
 }

package/dist/connection.d.ts

@@ -45,6 +45,7 @@ export declare abstract class AbstractGoogleLLMConnection<MessageType, AuthOptio
     abstract formatContents(input: MessageType, parameters: GoogleAIModelRequestParams): GeminiContent[];
     formatGenerationConfig(_input: MessageType, parameters: GoogleAIModelRequestParams): GeminiGenerationConfig;
     formatSafetySettings(_input: MessageType, parameters: GoogleAIModelRequestParams): GeminiSafetySetting[];
+    formatSystemInstruction(_input: MessageType, _parameters: GoogleAIModelRequestParams): GeminiContent;
     isStructuredToolArray(tools?: unknown[]): tools is StructuredToolInterface[];
     structuredToolToFunctionDeclaration(tool: StructuredToolInterface): GeminiFunctionDeclaration;
     structuredToolsToGeminiTools(tools: StructuredToolInterface[]): GeminiTool[];

package/dist/connection.js

@@ -207,6 +207,9 @@ export class AbstractGoogleLLMConnection extends GoogleAIConnection {
     formatSafetySettings(_input, parameters) {
         return parameters.safetySettings ?? [];
     }
+    formatSystemInstruction(_input, _parameters) {
+        return {};
+    }
     // Borrowed from the OpenAI invocation params test
     isStructuredToolArray(tools) {
         return (tools !== undefined &&
@@ -247,6 +250,7 @@ export class AbstractGoogleLLMConnection extends GoogleAIConnection {
         const generationConfig = this.formatGenerationConfig(input, parameters);
         const tools = this.formatTools(input, parameters);
         const safetySettings = this.formatSafetySettings(input, parameters);
+        const systemInstruction = this.formatSystemInstruction(input, parameters);
         const ret = {
             contents,
             generationConfig,
@@ -257,6 +261,11 @@ export class AbstractGoogleLLMConnection extends GoogleAIConnection {
         if (safetySettings && safetySettings.length) {
             ret.safetySettings = safetySettings;
         }
+        if (systemInstruction?.role &&
+            systemInstruction?.parts &&
+            systemInstruction?.parts?.length) {
+            ret.systemInstruction = systemInstruction;
+        }
         return ret;
     }
 }

package/dist/types.d.ts

@@ -73,6 +73,7 @@ export interface GoogleAIModelParams {
     topK?: number;
     stopSequences?: string[];
     safetySettings?: GoogleAISafetySetting[];
+    convertSystemMessageToHumanContent?: boolean;
 }
 /**
  * The params which can be passed to the API at request time.
@@ -128,7 +129,7 @@ export type GeminiSafetyRating = {
     category: string;
     probability: string;
 } & Record<string, unknown>;
-export type GeminiRole = "user" | "model" | "function";
+export type GeminiRole = "system" | "user" | "model" | "function";
 export interface GeminiContent {
     parts: GeminiPart[];
     role: GeminiRole;
@@ -162,6 +163,7 @@ export interface GeminiGenerationConfig {
 }
 export interface GeminiRequest {
     contents?: GeminiContent[];
+    systemInstruction?: GeminiContent;
     tools?: GeminiTool[];
     safetySettings?: GeminiSafetySetting[];
     generationConfig?: GeminiGenerationConfig;

package/dist/utils/common.cjs

@@ -24,6 +24,10 @@ function copyAIModelParamsInto(params, options, target) {
         options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
     ret.safetySettings =
         options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.convertSystemMessageToHumanContent =
+        options?.convertSystemMessageToHumanContent ??
+            params?.convertSystemMessageToHumanContent ??
+            target?.convertSystemMessageToHumanContent;
     ret.tools = options?.tools;
     // Ensure tools are formatted properly for Gemini
     const geminiTools = options?.tools

package/dist/utils/common.js

@@ -20,6 +20,10 @@ export function copyAIModelParamsInto(params, options, target) {
         options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
     ret.safetySettings =
         options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.convertSystemMessageToHumanContent =
+        options?.convertSystemMessageToHumanContent ??
+            params?.convertSystemMessageToHumanContent ??
+            target?.convertSystemMessageToHumanContent;
     ret.tools = options?.tools;
     // Ensure tools are formatted properly for Gemini
     const geminiTools = options?.tools

package/dist/utils/gemini.cjs

@@ -158,11 +158,13 @@ function roleMessageToContent(role, message) {
         },
     ];
 }
-function systemMessageToContent(message) {
-    return [
-        ...roleMessageToContent("user", message),
-        ...roleMessageToContent("model", new messages_1.AIMessage("Ok")),
-    ];
+function systemMessageToContent(message, useSystemInstruction) {
+    return useSystemInstruction
+        ? roleMessageToContent("system", message)
+        : [
+            ...roleMessageToContent("user", message),
+            ...roleMessageToContent("model", new messages_1.AIMessage("Ok")),
+        ];
 }
 function toolMessageToContent(message, prevMessage) {
     const contentStr = typeof message.content === "string"
@@ -211,11 +213,11 @@ function toolMessageToContent(message, prevMessage) {
         ];
     }
 }
-function baseMessageToContent(message, prevMessage) {
+function baseMessageToContent(message, prevMessage, useSystemInstruction) {
     const type = message._getType();
     switch (type) {
         case "system":
-            return systemMessageToContent(message);
+            return systemMessageToContent(message, useSystemInstruction);
         case "human":
             return roleMessageToContent("user", message);
         case "ai":

package/dist/utils/gemini.d.ts

@@ -2,7 +2,7 @@ import { AIMessageFields, BaseMessage, BaseMessageChunk, BaseMessageFields, Mess
 import { ChatGeneration, ChatGenerationChunk, ChatResult, Generation } from "@langchain/core/outputs";
 import type { GoogleLLMResponse, GoogleAIModelParams, GeminiPart, GeminiContent, GenerateContentResponseData, GoogleAISafetyHandler } from "../types.js";
 export declare function messageContentToParts(content: MessageContent): GeminiPart[];
-export declare function baseMessageToContent(message: BaseMessage, prevMessage?: BaseMessage): GeminiContent[];
+export declare function baseMessageToContent(message: BaseMessage, prevMessage: BaseMessage | undefined, useSystemInstruction: boolean): GeminiContent[];
 export declare function partsToMessageContent(parts: GeminiPart[]): MessageContent;
 interface FunctionCall {
     name: string;

package/dist/utils/gemini.js

@@ -154,11 +154,13 @@ function roleMessageToContent(role, message) {
         },
     ];
 }
-function systemMessageToContent(message) {
-    return [
-        ...roleMessageToContent("user", message),
-        ...roleMessageToContent("model", new AIMessage("Ok")),
-    ];
+function systemMessageToContent(message, useSystemInstruction) {
+    return useSystemInstruction
+        ? roleMessageToContent("system", message)
+        : [
+            ...roleMessageToContent("user", message),
+            ...roleMessageToContent("model", new AIMessage("Ok")),
+        ];
 }
 function toolMessageToContent(message, prevMessage) {
     const contentStr = typeof message.content === "string"
@@ -207,11 +209,11 @@ function toolMessageToContent(message, prevMessage) {
         ];
     }
 }
-export function baseMessageToContent(message, prevMessage) {
+export function baseMessageToContent(message, prevMessage, useSystemInstruction) {
     const type = message._getType();
     switch (type) {
         case "system":
-            return systemMessageToContent(message);
+            return systemMessageToContent(message, useSystemInstruction);
         case "human":
             return roleMessageToContent("user", message);
         case "ai":

package/package.json

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