@langchain/google-common 0.0.0 → 0.0.2

package/dist/types.d.ts

@@ -1,4 +1,6 @@
 import type { BaseLLMParams } from "@langchain/core/language_models/llms";
+import { BaseLanguageModelCallOptions } from "@langchain/core/language_models/base";
+import { StructuredToolInterface } from "@langchain/core/tools";
 import type { JsonStream } from "./utils/stream.js";
 /**
  * Parameters needed to setup the client connection.
@@ -36,8 +38,10 @@ export interface GoogleAISafetySetting {
     threshold: string;
 }
 export interface GoogleAIModelParams {
-    /** Model to use */
+    /** @deprecated Prefer `modelName` */
     model?: string;
+    /** Model to use */
+    modelName?: string;
     /** Sampling temperature to use */
     temperature?: number;
     /**
@@ -67,7 +71,20 @@ export interface GoogleAIModelParams {
     stopSequences?: string[];
     safetySettings?: GoogleAISafetySetting[];
 }
-export interface GoogleAIBaseLLMInput<AuthOptions> extends BaseLLMParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams {
+/**
+ * The params which can be passed to the API at request time.
+ */
+export interface GoogleAIModelRequestParams extends GoogleAIModelParams {
+    tools?: StructuredToolInterface[] | GeminiTool[];
+}
+export interface GoogleAIBaseLLMInput<AuthOptions> extends BaseLLMParams, GoogleConnectionParams<AuthOptions>, GoogleAIModelParams, GoogleAISafetyParams {
+}
+export interface GoogleAIBaseLanguageModelCallOptions extends BaseLanguageModelCallOptions, GoogleAIModelRequestParams, GoogleAISafetyParams {
+}
+/**
+ * Input to LLM class.
+ */
+export interface GoogleBaseLLMInput<AuthOptions> extends GoogleAIBaseLLMInput<AuthOptions> {
 }
 export interface GoogleResponse {
     data: any;
@@ -76,20 +93,28 @@ export interface GeminiPartText {
     text: string;
 }
 export interface GeminiPartInlineData {
-    mimeType: string;
-    data: string;
+    inlineData: {
+        mimeType: string;
+        data: string;
+    };
 }
 export interface GeminiPartFileData {
-    mimeType: string;
-    fileUri: string;
+    fileData: {
+        mimeType: string;
+        fileUri: string;
+    };
 }
 export interface GeminiPartFunctionCall {
-    name: string;
-    args?: object;
+    functionCall: {
+        name: string;
+        args?: object;
+    };
 }
 export interface GeminiPartFunctionResponse {
-    name: string;
-    response: object;
+    functionResponse: {
+        name: string;
+        response: object;
+    };
 }
 export type GeminiPart = GeminiPartText | GeminiPartInlineData | GeminiPartFileData | GeminiPartFunctionCall | GeminiPartFunctionResponse;
 export interface GeminiSafetySetting {
@@ -100,13 +125,30 @@ export interface GeminiSafetyRating {
     category: string;
     probability: string;
 }
-export type GeminiRole = "user" | "model";
+export type GeminiRole = "user" | "model" | "function";
 export interface GeminiContent {
     parts: GeminiPart[];
     role: GeminiRole;
 }
 export interface GeminiTool {
+    functionDeclarations?: GeminiFunctionDeclaration[];
 }
+export interface GeminiFunctionDeclaration {
+    name: string;
+    description: string;
+    parameters?: GeminiFunctionSchema;
+}
+export interface GeminiFunctionSchema {
+    type: GeminiFunctionSchemaType;
+    format?: string;
+    description?: string;
+    nullable?: boolean;
+    enum?: string[];
+    properties?: Record<string, GeminiFunctionSchema>;
+    required?: string[];
+    items?: GeminiFunctionSchema;
+}
+export type GeminiFunctionSchemaType = "string" | "number" | "integer" | "boolean" | "array" | "object";
 export interface GeminiGenerationConfig {
     stopSequences?: string[];
     candidateCount?: number;
@@ -132,6 +174,7 @@ interface GeminiResponseCandidate {
     safetyRatings: GeminiSafetyRating[];
 }
 interface GeminiResponsePromptFeedback {
+    blockReason?: string;
     safetyRatings: GeminiSafetyRating[];
 }
 export interface GenerateContentResponseData {
@@ -143,4 +186,16 @@ export type GoogleLLMResponseData = JsonStream | GenerateContentResponseData | G
 export interface GoogleLLMResponse extends GoogleResponse {
     data: GoogleLLMResponseData;
 }
+export interface GoogleAISafetyHandler {
+    /**
+     * A function that will take a response and return the, possibly modified,
+     * response or throw an exception if there are safety issues.
+     *
+     * @throws GoogleAISafetyError
+     */
+    handle(response: GoogleLLMResponse): GoogleLLMResponse;
+}
+export interface GoogleAISafetyParams {
+    safetyHandler?: GoogleAISafetyHandler;
+}
 export {};

package/dist/utils/common.cjs

@@ -2,19 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.copyAndValidateModelParamsInto = exports.validateModelParams = exports.modelToFamily = exports.copyAIModelParamsInto = exports.copyAIModelParams = void 0;
 const gemini_js_1 = require("./gemini.cjs");
-function copyAIModelParams(params) {
-    return copyAIModelParamsInto(params, {});
+function copyAIModelParams(params, options) {
+    return copyAIModelParamsInto(params, options, {});
 }
 exports.copyAIModelParams = copyAIModelParams;
-function copyAIModelParamsInto(params, target) {
+function copyAIModelParamsInto(params, options, target) {
     const ret = target || {};
-    ret.model = params?.model ?? target.model;
-    ret.temperature = params?.temperature ?? target.temperature;
-    ret.maxOutputTokens = params?.maxOutputTokens ?? target.maxOutputTokens;
-    ret.topP = params?.topP ?? target.topP;
-    ret.topK = params?.topK ?? target.topK;
-    ret.stopSequences = params?.stopSequences ?? target.stopSequences;
-    ret.safetySettings = params?.safetySettings ?? target.safetySettings;
+    ret.modelName = options?.modelName ?? params?.modelName ?? target.modelName;
+    ret.temperature =
+        options?.temperature ?? params?.temperature ?? target.temperature;
+    ret.maxOutputTokens =
+        options?.maxOutputTokens ??
+            params?.maxOutputTokens ??
+            target.maxOutputTokens;
+    ret.topP = options?.topP ?? params?.topP ?? target.topP;
+    ret.topK = options?.topK ?? params?.topK ?? target.topK;
+    ret.stopSequences =
+        options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
+    ret.safetySettings =
+        options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.tools = options?.tools;
     return ret;
 }
 exports.copyAIModelParamsInto = copyAIModelParamsInto;
@@ -32,7 +39,7 @@ function modelToFamily(modelName) {
 exports.modelToFamily = modelToFamily;
 function validateModelParams(params) {
     const testParams = params ?? {};
-    switch (modelToFamily(testParams.model)) {
+    switch (modelToFamily(testParams.modelName)) {
         case "gemini":
             return (0, gemini_js_1.validateGeminiParams)(testParams);
         default:
@@ -41,7 +48,7 @@ function validateModelParams(params) {
 }
 exports.validateModelParams = validateModelParams;
 function copyAndValidateModelParamsInto(params, target) {
-    copyAIModelParamsInto(params, target);
+    copyAIModelParamsInto(params, undefined, target);
     validateModelParams(target);
     return target;
 }

package/dist/utils/common.d.ts

@@ -1,6 +1,6 @@
-import type { GoogleAIModelParams, GoogleLLMModelFamily } from "../types.js";
-export declare function copyAIModelParams(params: GoogleAIModelParams | undefined): GoogleAIModelParams;
-export declare function copyAIModelParamsInto(params: GoogleAIModelParams | undefined, target: GoogleAIModelParams): GoogleAIModelParams;
+import type { GoogleAIBaseLanguageModelCallOptions, GoogleAIModelParams, GoogleAIModelRequestParams, GoogleLLMModelFamily } from "../types.js";
+export declare function copyAIModelParams(params: GoogleAIModelParams | undefined, options: GoogleAIBaseLanguageModelCallOptions | undefined): GoogleAIModelRequestParams;
+export declare function copyAIModelParamsInto(params: GoogleAIModelParams | undefined, options: GoogleAIBaseLanguageModelCallOptions | undefined, target: GoogleAIModelParams): GoogleAIModelRequestParams;
 export declare function modelToFamily(modelName: string | undefined): GoogleLLMModelFamily;
 export declare function validateModelParams(params: GoogleAIModelParams | undefined): void;
 export declare function copyAndValidateModelParamsInto(params: GoogleAIModelParams | undefined, target: GoogleAIModelParams): GoogleAIModelParams;

package/dist/utils/common.js

@@ -1,16 +1,23 @@
 import { isModelGemini, validateGeminiParams } from "./gemini.js";
-export function copyAIModelParams(params) {
-    return copyAIModelParamsInto(params, {});
+export function copyAIModelParams(params, options) {
+    return copyAIModelParamsInto(params, options, {});
 }
-export function copyAIModelParamsInto(params, target) {
+export function copyAIModelParamsInto(params, options, target) {
     const ret = target || {};
-    ret.model = params?.model ?? target.model;
-    ret.temperature = params?.temperature ?? target.temperature;
-    ret.maxOutputTokens = params?.maxOutputTokens ?? target.maxOutputTokens;
-    ret.topP = params?.topP ?? target.topP;
-    ret.topK = params?.topK ?? target.topK;
-    ret.stopSequences = params?.stopSequences ?? target.stopSequences;
-    ret.safetySettings = params?.safetySettings ?? target.safetySettings;
+    ret.modelName = options?.modelName ?? params?.modelName ?? target.modelName;
+    ret.temperature =
+        options?.temperature ?? params?.temperature ?? target.temperature;
+    ret.maxOutputTokens =
+        options?.maxOutputTokens ??
+            params?.maxOutputTokens ??
+            target.maxOutputTokens;
+    ret.topP = options?.topP ?? params?.topP ?? target.topP;
+    ret.topK = options?.topK ?? params?.topK ?? target.topK;
+    ret.stopSequences =
+        options?.stopSequences ?? params?.stopSequences ?? target.stopSequences;
+    ret.safetySettings =
+        options?.safetySettings ?? params?.safetySettings ?? target.safetySettings;
+    ret.tools = options?.tools;
     return ret;
 }
 export function modelToFamily(modelName) {
@@ -26,7 +33,7 @@ export function modelToFamily(modelName) {
 }
 export function validateModelParams(params) {
     const testParams = params ?? {};
-    switch (modelToFamily(testParams.model)) {
+    switch (modelToFamily(testParams.modelName)) {
         case "gemini":
             return validateGeminiParams(testParams);
         default:
@@ -34,7 +41,7 @@ export function validateModelParams(params) {
     }
 }
 export function copyAndValidateModelParamsInto(params, target) {
-    copyAIModelParamsInto(params, target);
+    copyAIModelParamsInto(params, undefined, target);
     validateModelParams(target);
     return target;
 }

package/dist/utils/failed_handler.cjs

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureParams = exports.failedAttemptHandler = void 0;
+const STATUS_NO_RETRY = [
+    400,
+    401,
+    402,
+    403,
+    404,
+    405,
+    406,
+    407,
+    408,
+    409, // Conflict
+];
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function failedAttemptHandler(error) {
+    const status = error?.response?.status ?? 0;
+    if (status === 0) {
+        // What is this?
+        console.error("failedAttemptHandler", error);
+    }
+    // What errors shouldn't be retried?
+    if (STATUS_NO_RETRY.includes(+status)) {
+        throw error;
+    }
+    throw error;
+}
+exports.failedAttemptHandler = failedAttemptHandler;
+function ensureParams(params) {
+    const base = params ?? {};
+    return {
+        onFailedAttempt: failedAttemptHandler,
+        ...base,
+    };
+}
+exports.ensureParams = ensureParams;

package/dist/utils/failed_handler.d.ts

@@ -0,0 +1,3 @@
+import { AsyncCallerParams } from "@langchain/core/utils/async_caller";
+export declare function failedAttemptHandler(error: any): void;
+export declare function ensureParams(params?: AsyncCallerParams): AsyncCallerParams;

package/dist/utils/failed_handler.js

@@ -0,0 +1,32 @@
+const STATUS_NO_RETRY = [
+    400,
+    401,
+    402,
+    403,
+    404,
+    405,
+    406,
+    407,
+    408,
+    409, // Conflict
+];
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function failedAttemptHandler(error) {
+    const status = error?.response?.status ?? 0;
+    if (status === 0) {
+        // What is this?
+        console.error("failedAttemptHandler", error);
+    }
+    // What errors shouldn't be retried?
+    if (STATUS_NO_RETRY.includes(+status)) {
+        throw error;
+    }
+    throw error;
+}
+export function ensureParams(params) {
+    const base = params ?? {};
+    return {
+        onFailedAttempt: failedAttemptHandler,
+        ...base,
+    };
+}