@langchain/google-common 0.1.6 → 0.1.8

package/dist/chat_models.cjs

@@ -151,12 +151,36 @@ class ChatGoogleBase extends chat_models_1.BaseChatModel {
             writable: true,
             value: 40
         });
+        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,

package/dist/chat_models.d.ts

@@ -41,7 +41,11 @@ export declare abstract class ChatGoogleBase<AuthOptions> extends BaseChatModel<
     maxOutputTokens: number;
     topP: number;
     topK: number;
+    presencePenalty: number;
+    frequencyPenalty: number;
     stopSequences: string[];
+    logprobs: boolean;
+    topLogprobs: number;
     safetySettings: GoogleAISafetySetting[];
     convertSystemMessageToHumanContent: boolean | undefined;
     safetyHandler: GoogleAISafetyHandler;

package/dist/chat_models.js

@@ -147,12 +147,36 @@ export class ChatGoogleBase extends BaseChatModel {
             writable: true,
             value: 40
         });
+        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,

package/dist/output_parsers.cjs

@@ -15,8 +15,8 @@ class BaseGoogleSearchOutputParser extends output_parsers_1.BaseLLMOutputParser
     generationToGroundingInfo(generation) {
         if ("message" in generation) {
             const responseMetadata = generation?.message?.response_metadata;
-            const metadata = responseMetadata.groundingMetadata;
-            const supports = responseMetadata.groundingSupport ?? metadata.groundingSupports ?? [];
+            const metadata = responseMetadata?.groundingMetadata;
+            const supports = responseMetadata?.groundingSupport ?? metadata?.groundingSupports ?? [];
             if (metadata) {
                 return {
                     metadata,
@@ -90,7 +90,7 @@ class BaseGoogleSearchOutputParser extends output_parsers_1.BaseLLMOutputParser
      * @param grounding
      */
     searchSuggestion(grounding) {
-        return grounding.metadata.searchEntryPoint?.renderedContent ?? "";
+        return grounding?.metadata?.searchEntryPoint?.renderedContent ?? "";
     }
     annotateText(text, grounding) {
         const prefix = this.textPrefix(text, grounding) ?? "";
@@ -125,7 +125,7 @@ class SimpleGoogleSearchOutputParser extends BaseGoogleSearchOutputParser {
     }
     textSuffix(_text, grounding) {
         let ret = "\n";
-        const chunks = grounding.metadata.groundingChunks;
+        const chunks = grounding?.metadata?.groundingChunks ?? [];
         chunks.forEach((chunk, index) => {
             ret = `${ret}${this.chunkToString(chunk, index)}\n`;
         });

package/dist/output_parsers.js

@@ -12,8 +12,8 @@ export class BaseGoogleSearchOutputParser extends BaseLLMOutputParser {
     generationToGroundingInfo(generation) {
         if ("message" in generation) {
             const responseMetadata = generation?.message?.response_metadata;
-            const metadata = responseMetadata.groundingMetadata;
-            const supports = responseMetadata.groundingSupport ?? metadata.groundingSupports ?? [];
+            const metadata = responseMetadata?.groundingMetadata;
+            const supports = responseMetadata?.groundingSupport ?? metadata?.groundingSupports ?? [];
             if (metadata) {
                 return {
                     metadata,
@@ -87,7 +87,7 @@ export class BaseGoogleSearchOutputParser extends BaseLLMOutputParser {
      * @param grounding
      */
     searchSuggestion(grounding) {
-        return grounding.metadata.searchEntryPoint?.renderedContent ?? "";
+        return grounding?.metadata?.searchEntryPoint?.renderedContent ?? "";
     }
     annotateText(text, grounding) {
         const prefix = this.textPrefix(text, grounding) ?? "";
@@ -121,7 +121,7 @@ export class SimpleGoogleSearchOutputParser extends BaseGoogleSearchOutputParser
     }
     textSuffix(_text, grounding) {
         let ret = "\n";
-        const chunks = grounding.metadata.groundingChunks;
+        const chunks = grounding?.metadata?.groundingChunks ?? [];
         chunks.forEach((chunk, index) => {
             ret = `${ret}${this.chunkToString(chunk, index)}\n`;
         });

package/dist/types.d.ts

@@ -118,6 +118,34 @@ export interface GoogleAIModelParams {
      * among the 3 most probable tokens (using temperature).
      */
     topK?: number;
+    /**
+     * Presence penalty applied to the next token's logprobs
+     * if the token has already been seen in the response.
+     * This penalty is binary on/off and not dependant on the
+     * number of times the token is used (after the first).
+     * Use frequencyPenalty for a penalty that increases with each use.
+     * A positive penalty will discourage the use of tokens that have
+     * already been used in the response, increasing the vocabulary.
+     * A negative penalty will encourage the use of tokens that have
+     * already been used in the response, decreasing the vocabulary.
+     */
+    presencePenalty?: number;
+    /**
+     * Frequency penalty applied to the next token's logprobs,
+     * multiplied by the number of times each token has been seen
+     * in the respponse so far.
+     * A positive penalty will discourage the use of tokens that
+     * have already been used, proportional to the number of times
+     * the token has been used:
+     * The more a token is used, the more dificult it is for the model
+     * to use that token again increasing the vocabulary of responses.
+     * Caution: A _negative_ penalty will encourage the model to reuse
+     * tokens proportional to the number of times the token has been used.
+     * Small negative values will reduce the vocabulary of a response.
+     * Larger negative values will cause the model to start repeating
+     * a common token until it hits the maxOutputTokens limit.
+     */
+    frequencyPenalty?: number;
     stopSequences?: string[];
     safetySettings?: GoogleAISafetySetting[];
     convertSystemMessageToHumanContent?: boolean;
@@ -136,6 +164,19 @@ export interface GoogleAIModelParams {
      * @default false
      */
     streaming?: boolean;
+    /**
+     * Whether to return log probabilities of the output tokens or not.
+     * If true, returns the log probabilities of each output token
+     * returned in the content of message.
+     */
+    logprobs?: boolean;
+    /**
+     * An integer between 0 and 5 specifying the number of
+     * most likely tokens to return at each token position,
+     * each with an associated log probability.
+     * logprobs must be set to true if this parameter is used.
+     */
+    topLogprobs?: number;
 }
 export type GoogleAIToolType = BindToolsInput | GeminiTool;
 /**
@@ -273,6 +314,18 @@ export interface GeminiSegment {
 export interface GeminiRetrievalMetadata {
     googleSearchDynamicRetrievalScore: number;
 }
+export interface GeminiLogprobsResult {
+    topCandidates: GeminiLogprobsTopCandidate[];
+    chosenCandidates: GeminiLogprobsResultCandidate[];
+}
+export interface GeminiLogprobsTopCandidate {
+    candidates: GeminiLogprobsResultCandidate[];
+}
+export interface GeminiLogprobsResultCandidate {
+    token: string;
+    tokenId: number;
+    logProbability: number;
+}
 export type GeminiRole = "system" | "user" | "model" | "function";
 export interface GeminiContent {
     parts: GeminiPart[];
@@ -324,7 +377,11 @@ export interface GeminiGenerationConfig {
     temperature?: number;
     topP?: number;
     topK?: number;
+    presencePenalty?: number;
+    frequencyPenalty?: number;
     responseMimeType?: GoogleAIResponseMimeType;
+    responseLogprobs?: boolean;
+    logprobs?: number;
 }
 export interface GeminiRequest {
     contents?: GeminiContent[];
@@ -339,7 +396,7 @@ export interface GeminiRequest {
     safetySettings?: GeminiSafetySetting[];
     generationConfig?: GeminiGenerationConfig;
 }
-interface GeminiResponseCandidate {
+export interface GeminiResponseCandidate {
     content: {
         parts: GeminiPart[];
         role: string;
@@ -350,6 +407,8 @@ interface GeminiResponseCandidate {
     safetyRatings: GeminiSafetyRating[];
     citationMetadata?: GeminiCitationMetadata;
     groundingMetadata?: GeminiGroundingMetadata;
+    avgLogprobs?: number;
+    logprobsResult: GeminiLogprobsResult;
 }
 interface GeminiResponsePromptFeedback {
     blockReason?: string;

package/dist/utils/common.cjs

@@ -105,10 +105,21 @@ function copyAIModelParamsInto(params, options, target) {
             target.maxOutputTokens;
     ret.topP = options?.topP ?? params?.topP ?? target.topP;
     ret.topK = options?.topK ?? params?.topK ?? target.topK;
+    ret.presencePenalty =
+        options?.presencePenalty ??
+            params?.presencePenalty ??
+            target.presencePenalty;
+    ret.frequencyPenalty =
+        options?.frequencyPenalty ??
+            params?.frequencyPenalty ??
+            target.frequencyPenalty;
     ret.stopSequences =
         options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
     ret.safetySettings =
         options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.logprobs = options?.logprobs ?? params?.logprobs ?? target.logprobs;
+    ret.topLogprobs =
+        options?.topLogprobs ?? params?.topLogprobs ?? target.topLogprobs;
     ret.convertSystemMessageToHumanContent =
         options?.convertSystemMessageToHumanContent ??
             params?.convertSystemMessageToHumanContent ??

package/dist/utils/common.js

@@ -100,10 +100,21 @@ export function copyAIModelParamsInto(params, options, target) {
             target.maxOutputTokens;
     ret.topP = options?.topP ?? params?.topP ?? target.topP;
     ret.topK = options?.topK ?? params?.topK ?? target.topK;
+    ret.presencePenalty =
+        options?.presencePenalty ??
+            params?.presencePenalty ??
+            target.presencePenalty;
+    ret.frequencyPenalty =
+        options?.frequencyPenalty ??
+            params?.frequencyPenalty ??
+            target.frequencyPenalty;
     ret.stopSequences =
         options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
     ret.safetySettings =
         options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.logprobs = options?.logprobs ?? params?.logprobs ?? target.logprobs;
+    ret.topLogprobs =
+        options?.topLogprobs ?? params?.topLogprobs ?? target.topLogprobs;
     ret.convertSystemMessageToHumanContent =
         options?.convertSystemMessageToHumanContent ??
             params?.convertSystemMessageToHumanContent ??

package/dist/utils/failed_handler.cjs

@@ -19,12 +19,12 @@ function failedAttemptHandler(error) {
     if (status === 0) {
         // What is this?
         console.error("failedAttemptHandler", error);
+        throw error;
     }
     // What errors shouldn't be retried?
     if (STATUS_NO_RETRY.includes(+status)) {
         throw error;
     }
-    throw error;
 }
 exports.failedAttemptHandler = failedAttemptHandler;
 function ensureParams(params) {

package/dist/utils/failed_handler.js

@@ -16,12 +16,12 @@ export function failedAttemptHandler(error) {
     if (status === 0) {
         // What is this?
         console.error("failedAttemptHandler", error);
+        throw error;
     }
     // What errors shouldn't be retried?
     if (STATUS_NO_RETRY.includes(+status)) {
         throw error;
     }
-    throw error;
 }
 export function ensureParams(params) {
     const base = params ?? {};

package/dist/utils/gemini.cjs

@@ -506,6 +506,33 @@ function getGeminiAPI(config) {
     function safeResponseToString(response) {
         return safeResponseTo(response, responseToString);
     }
+    function logprobResultToLogprob(result) {
+        const token = result?.token;
+        const logprob = result?.logProbability;
+        const encoder = new TextEncoder();
+        const bytes = Array.from(encoder.encode(token));
+        return {
+            token,
+            logprob,
+            bytes,
+        };
+    }
+    function candidateToLogprobs(candidate) {
+        const logprobs = candidate?.logprobsResult;
+        const chosenTokens = logprobs?.chosenCandidates ?? [];
+        const topTokens = logprobs?.topCandidates ?? [];
+        const content = [];
+        for (let co = 0; co < chosenTokens.length; co += 1) {
+            const chosen = chosenTokens[co];
+            const top = topTokens[co]?.candidates ?? [];
+            const logprob = logprobResultToLogprob(chosen);
+            logprob.top_logprobs = top.map((l) => logprobResultToLogprob(l));
+            content.push(logprob);
+        }
+        return {
+            content,
+        };
+    }
     function responseToGenerationInfo(response) {
         if (!Array.isArray(response.data)) {
             return {};
@@ -527,6 +554,8 @@ function getGeminiAPI(config) {
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
             finish_reason: data.candidates[0]?.finishReason,
+            avgLogprobs: data.candidates[0]?.avgLogprobs,
+            logprobs: candidateToLogprobs(data.candidates[0]),
         };
     }
     function responseToChatGeneration(response) {
@@ -665,6 +694,18 @@ function getGeminiAPI(config) {
                 }),
             ];
         }
+        // Add logprobs information to the message
+        const candidate = response?.data
+            ?.candidates?.[0];
+        const avgLogprobs = candidate?.avgLogprobs;
+        const logprobs = candidateToLogprobs(candidate);
+        if (logprobs) {
+            ret[0].message.response_metadata = {
+                ...ret[0].message.response_metadata,
+                logprobs,
+                avgLogprobs,
+            };
+        }
         return ret;
     }
     function responseToBaseMessageFields(response) {
@@ -788,14 +829,25 @@ function getGeminiAPI(config) {
         }
     }
     function formatGenerationConfig(parameters) {
-        return {
+        const ret = {
             temperature: parameters.temperature,
             topK: parameters.topK,
             topP: parameters.topP,
+            presencePenalty: parameters.presencePenalty,
+            frequencyPenalty: parameters.frequencyPenalty,
             maxOutputTokens: parameters.maxOutputTokens,
             stopSequences: parameters.stopSequences,
             responseMimeType: parameters.responseMimeType,
         };
+        // Add the logprobs if explicitly set
+        if (typeof parameters.logprobs !== "undefined") {
+            ret.responseLogprobs = parameters.logprobs;
+            if (parameters.logprobs &&
+                typeof parameters.topLogprobs !== "undefined") {
+                ret.logprobs = parameters.topLogprobs;
+            }
+        }
+        return ret;
     }
     function formatSafetySettings(parameters) {
         return parameters.safetySettings ?? [];

package/dist/utils/gemini.js

@@ -501,6 +501,33 @@ export function getGeminiAPI(config) {
     function safeResponseToString(response) {
         return safeResponseTo(response, responseToString);
     }
+    function logprobResultToLogprob(result) {
+        const token = result?.token;
+        const logprob = result?.logProbability;
+        const encoder = new TextEncoder();
+        const bytes = Array.from(encoder.encode(token));
+        return {
+            token,
+            logprob,
+            bytes,
+        };
+    }
+    function candidateToLogprobs(candidate) {
+        const logprobs = candidate?.logprobsResult;
+        const chosenTokens = logprobs?.chosenCandidates ?? [];
+        const topTokens = logprobs?.topCandidates ?? [];
+        const content = [];
+        for (let co = 0; co < chosenTokens.length; co += 1) {
+            const chosen = chosenTokens[co];
+            const top = topTokens[co]?.candidates ?? [];
+            const logprob = logprobResultToLogprob(chosen);
+            logprob.top_logprobs = top.map((l) => logprobResultToLogprob(l));
+            content.push(logprob);
+        }
+        return {
+            content,
+        };
+    }
     function responseToGenerationInfo(response) {
         if (!Array.isArray(response.data)) {
             return {};
@@ -522,6 +549,8 @@ export function getGeminiAPI(config) {
             citation_metadata: data.candidates[0]?.citationMetadata,
             grounding_metadata: data.candidates[0]?.groundingMetadata,
             finish_reason: data.candidates[0]?.finishReason,
+            avgLogprobs: data.candidates[0]?.avgLogprobs,
+            logprobs: candidateToLogprobs(data.candidates[0]),
         };
     }
     function responseToChatGeneration(response) {
@@ -660,6 +689,18 @@ export function getGeminiAPI(config) {
                 }),
             ];
         }
+        // Add logprobs information to the message
+        const candidate = response?.data
+            ?.candidates?.[0];
+        const avgLogprobs = candidate?.avgLogprobs;
+        const logprobs = candidateToLogprobs(candidate);
+        if (logprobs) {
+            ret[0].message.response_metadata = {
+                ...ret[0].message.response_metadata,
+                logprobs,
+                avgLogprobs,
+            };
+        }
         return ret;
     }
     function responseToBaseMessageFields(response) {
@@ -783,14 +824,25 @@ export function getGeminiAPI(config) {
         }
     }
     function formatGenerationConfig(parameters) {
-        return {
+        const ret = {
             temperature: parameters.temperature,
             topK: parameters.topK,
             topP: parameters.topP,
+            presencePenalty: parameters.presencePenalty,
+            frequencyPenalty: parameters.frequencyPenalty,
             maxOutputTokens: parameters.maxOutputTokens,
             stopSequences: parameters.stopSequences,
             responseMimeType: parameters.responseMimeType,
         };
+        // Add the logprobs if explicitly set
+        if (typeof parameters.logprobs !== "undefined") {
+            ret.responseLogprobs = parameters.logprobs;
+            if (parameters.logprobs &&
+                typeof parameters.topLogprobs !== "undefined") {
+                ret.logprobs = parameters.topLogprobs;
+            }
+        }
+        return ret;
     }
     function formatSafetySettings(parameters) {
         return parameters.safetySettings ?? [];

package/package.json

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