@intrvls/langchain-google-genai 3.0.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,336 @@
+import { GenerateContentConfig, GenerateContentParameters, GenerateContentResponse, SafetySetting, Schema, Tool } from "@google/genai";
+import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
+import { AIMessageChunk, BaseMessage } from "@langchain/core/messages";
+import { ChatGenerationChunk, ChatResult } from "@langchain/core/outputs";
+import { BaseChatModel, BaseChatModelCallOptions, BaseChatModelParams, BindToolsInput, LangSmithParams } from "@langchain/core/language_models/chat_models";
+import { ModelProfile } from "@langchain/core/language_models/profile";
+import { BaseLanguageModelInput, StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
+import { Runnable } from "@langchain/core/runnables";
+import { InteropZodType } from "@langchain/core/utils/types";
+import { SerializableSchema } from "@langchain/core/utils/standard_schema";
+import { Embeddings, EmbeddingsParams } from "@langchain/core/embeddings";
+
+//#region src/types.d.ts
+/**
+ * Tools accepted by `ChatGoogleGenerativeAI`.
+ *
+ * In `@google/genai` the previously distinct tool shapes
+ * (`FunctionDeclarationsTool`, `CodeExecutionTool`,
+ * `GoogleSearchRetrievalTool`, ...) have all been folded into a single
+ * `Tool` interface whose fields (`functionDeclarations`, `codeExecution`,
+ * `googleSearch`/`googleSearchRetrieval`, ...) are individually optional.
+ */
+type GoogleGenerativeAIToolType = BindToolsInput | Tool;
+type GoogleGenerativeAIThinkingConfig = {
+  /** Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. */includeThoughts?: boolean; /** The number of thoughts tokens that the model should generate. */
+  thinkingBudget?: number; /** Optional. The level of thoughts tokens that the model should generate. */
+  thinkingLevel?: GoogleGenerativeAIThinkingLevel;
+};
+type GoogleGenerativeAIThinkingLevel = "THINKING_LEVEL_UNSPECIFIED" | "MINIMAL" | "LOW" | "MEDIUM" | "HIGH";
+//#endregion
+//#region src/chat_models.d.ts
+type BaseMessageExamplePair = {
+  input: BaseMessage;
+  output: BaseMessage;
+};
+interface GoogleGenerativeAIChatCallOptions extends BaseChatModelCallOptions {
+  tools?: GoogleGenerativeAIToolType[];
+  /**
+   * Allowed functions to call when the mode is "any".
+   * If empty, any one of the provided functions are called.
+   */
+  allowedFunctionNames?: string[];
+  /**
+   * Whether or not to include usage data, like token counts
+   * in the streamed response chunks.
+   * @default true
+   */
+  streamUsage?: boolean;
+  /**
+   * JSON schema to be returned by the model.
+   */
+  responseSchema?: Schema;
+}
+/**
+ * An interface defining the input to the ChatGoogleGenerativeAI class.
+ */
+interface GoogleGenerativeAIChatInput extends BaseChatModelParams, Pick<GoogleGenerativeAIChatCallOptions, "streamUsage"> {
+  /**
+   * Model Name to use
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  model: string;
+  /**
+   * Controls the randomness of the output.
+   *
+   * Values can range from [0.0,2.0], inclusive. A value closer to 2.0
+   * will produce responses that are more varied and creative, while
+   * a value closer to 0.0 will typically result in less surprising
+   * responses from the model.
+   *
+   * Note: The default value varies by model
+   */
+  temperature?: number;
+  /**
+   * Maximum number of tokens to generate in the completion.
+   */
+  maxOutputTokens?: number;
+  /**
+   * Top-p changes how the model selects tokens for output.
+   *
+   * Tokens are selected from most probable to least until the sum
+   * of their probabilities equals the top-p value.
+   *
+   * For example, if tokens A, B, and C have a probability of
+   * .3, .2, and .1 and the top-p value is .5, then the model will
+   * select either A or B as the next token (using temperature).
+   *
+   * Note: The default value varies by model
+   */
+  topP?: number;
+  /**
+   * Top-k changes how the model selects tokens for output.
+   *
+   * A top-k of 1 means the selected token is the most probable among
+   * all tokens in the model's vocabulary (also called greedy decoding),
+   * while a top-k of 3 means that the next token is selected from
+   * among the 3 most probable tokens (using temperature).
+   *
+   * Note: The default value varies by model
+   */
+  topK?: number;
+  /**
+   * The set of character sequences (up to 5) that will stop output generation.
+   * If specified, the API will stop at the first appearance of a stop
+   * sequence.
+   *
+   * Note: The stop sequence will not be included as part of the response.
+   * Note: stopSequences is only supported for Gemini models
+   */
+  stopSequences?: string[];
+  /**
+   * A list of unique `SafetySetting` instances for blocking unsafe content. The API will block
+   * any prompts and responses that fail to meet the thresholds set by these settings. If there
+   * is no `SafetySetting` for a given `SafetyCategory` provided in the list, the API will use
+   * the default safety setting for that category.
+   */
+  safetySettings?: SafetySetting[];
+  /**
+   * Google API key to use
+   */
+  apiKey?: string;
+  /**
+   * Google API version to use
+   */
+  apiVersion?: string;
+  /**
+   * Google API base URL to use
+   */
+  baseUrl?: string;
+  /**
+   * Google API custom headers to use
+   */
+  customHeaders?: Record<string, string>;
+  /** Whether to stream the results or not */
+  streaming?: boolean;
+  /**
+   * Whether or not to force the model to respond with JSON.
+   * Available for `gemini-1.5` models and later.
+   * @default false
+   */
+  json?: boolean;
+  /**
+   * Whether or not model supports system instructions.
+   * The following models support system instructions:
+   * - All Gemini 1.5 Pro model versions
+   * - All Gemini 1.5 Flash model versions
+   * - Gemini 1.0 Pro version gemini-1.0-pro-002
+   */
+  convertSystemMessageToHumanContent?: boolean | undefined;
+  /**
+   * Optional. Config for thinking features. An error will be returned if this
+   * field is set for models that don't support thinking.
+   */
+  thinkingConfig?: GoogleGenerativeAIThinkingConfig;
+  /**
+   * Optional. The server-generated resource name of a cached content
+   * (e.g. `cachedContents/abc123`) created via the Google GenAI caches API.
+   * When set, it is sent as `config.cachedContent` on every request so the
+   * model reuses the cached tokens.
+   *
+   * Create one with the underlying SDK, for example:
+   * ```typescript
+   * import { GoogleGenAI } from "@google/genai";
+   * const ai = new GoogleGenAI({ apiKey });
+   * const cache = await ai.caches.create({ model, config: { contents, systemInstruction, ttl: "300s" } });
+   * const llm = new ChatGoogleGenerativeAI({ model, cachedContent: cache.name });
+   * ```
+   */
+  cachedContent?: string;
+}
+declare class ChatGoogleGenerativeAI extends BaseChatModel<GoogleGenerativeAIChatCallOptions, AIMessageChunk> implements GoogleGenerativeAIChatInput {
+  static lc_name(): string;
+  lc_serializable: boolean;
+  get lc_secrets(): {
+    [key: string]: string;
+  } | undefined;
+  lc_namespace: string[];
+  get lc_aliases(): {
+    apiKey: string;
+  };
+  model: string;
+  temperature?: number;
+  maxOutputTokens?: number;
+  topP?: number;
+  topK?: number;
+  stopSequences: string[];
+  safetySettings?: SafetySetting[];
+  apiKey?: string;
+  streaming: boolean;
+  json?: boolean;
+  streamUsage: boolean;
+  convertSystemMessageToHumanContent: boolean | undefined;
+  thinkingConfig?: GoogleGenerativeAIThinkingConfig;
+  cachedContent?: string;
+  private client;
+  get _isMultimodalModel(): boolean;
+  constructor(model: string, fields?: Omit<GoogleGenerativeAIChatInput, "model">);
+  constructor(fields: GoogleGenerativeAIChatInput);
+  get useSystemInstruction(): boolean;
+  get computeUseSystemInstruction(): boolean;
+  getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
+  _combineLLMOutput(): never[];
+  _llmType(): string;
+  bindTools(tools: GoogleGenerativeAIToolType[], kwargs?: Partial<GoogleGenerativeAIChatCallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, GoogleGenerativeAIChatCallOptions>;
+  invocationParams(options?: this["ParsedCallOptions"]): GenerateContentConfig;
+  private _buildGenerateContentRequest;
+  _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
+  _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
+  completionWithRetry(request: GenerateContentParameters, options?: this["ParsedCallOptions"]): Promise<GenerateContentResponse>;
+  /**
+   * Return profiling information for the model.
+   *
+   * Provides information about the model's capabilities and constraints,
+   * including token limits, multimodal support, and advanced features like
+   * tool calling and structured output.
+   *
+   * @returns {ModelProfile} An object describing the model's capabilities and constraints
+   *
+   * @example
+   * ```typescript
+   * const model = new ChatGoogleGenerativeAI({ model: "gemini-2.5-flash" });
+   * const profile = model.profile;
+   * console.log(profile.maxInputTokens); // 1048576
+   * console.log(profile.imageInputs); // true
+   * ```
+   */
+  get profile(): ModelProfile;
+  withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | SerializableSchema<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
+  withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | SerializableSchema<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
+    raw: BaseMessage;
+    parsed: RunOutput;
+  }>;
+}
+//#endregion
+//#region src/embeddings.d.ts
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the GoogleGenerativeAIEmbeddings class.
+ */
+interface GoogleGenerativeAIEmbeddingsParams extends EmbeddingsParams {
+  /**
+   * Model Name to use
+   *
+   * Alias for `model`
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  modelName?: string;
+  /**
+   * Model Name to use
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  model?: string;
+  /**
+   * Type of task for which the embedding will be used
+   *
+   * Note: currently only supported by `embedding-001` model
+   */
+  taskType?: string;
+  /**
+   * An optional title for the text. Only applicable when TaskType is
+   * `RETRIEVAL_DOCUMENT`
+   *
+   * Note: currently only supported by `embedding-001` model
+   */
+  title?: string;
+  /**
+   * Whether to strip new lines from the input text. Default to true
+   */
+  stripNewLines?: boolean;
+  /**
+   * Google API key to use
+   */
+  apiKey?: string;
+  /**
+   * Google API base URL to use
+   */
+  baseUrl?: string;
+}
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Google Palm API.
+ * @example
+ * ```typescript
+ * const model = new GoogleGenerativeAIEmbeddings({
+ *   apiKey: "<YOUR API KEY>",
+ *   modelName: "embedding-001",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
+ */
+declare class GoogleGenerativeAIEmbeddings extends Embeddings implements GoogleGenerativeAIEmbeddingsParams {
+  apiKey?: string;
+  modelName: string;
+  model: string;
+  taskType?: string;
+  title?: string;
+  stripNewLines: boolean;
+  maxBatchSize: number;
+  private client;
+  constructor(fields?: GoogleGenerativeAIEmbeddingsParams);
+  private _cleanText;
+  private get _embedConfig();
+  protected _embedQueryContent(text: string): Promise<number[]>;
+  protected _embedDocumentsContent(documents: string[]): Promise<number[][]>;
+  /**
+   * Method that takes a document as input and returns a promise that
+   * resolves to an embedding for the document. It calls the _embedText
+   * method with the document as the input.
+   * @param document Document for which to generate an embedding.
+   * @returns Promise that resolves to an embedding for the input document.
+   */
+  embedQuery(document: string): Promise<number[]>;
+  /**
+   * Method that takes an array of documents as input and returns a promise
+   * that resolves to a 2D array of embeddings for each document. It calls
+   * the _embedText method for each document in the array.
+   * @param documents Array of documents for which to generate embeddings.
+   * @returns Promise that resolves to a 2D array of embeddings for each input document.
+   */
+  embedDocuments(documents: string[]): Promise<number[][]>;
+}
+//#endregion
+export { BaseMessageExamplePair, ChatGoogleGenerativeAI, GoogleGenerativeAIChatCallOptions, GoogleGenerativeAIChatInput, GoogleGenerativeAIEmbeddings, GoogleGenerativeAIEmbeddingsParams };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -0,0 +1,336 @@
+import { GenerateContentConfig, GenerateContentParameters, GenerateContentResponse, SafetySetting, Schema, Tool } from "@google/genai";
+import { BaseChatModel, BaseChatModelCallOptions, BaseChatModelParams, BindToolsInput, LangSmithParams } from "@langchain/core/language_models/chat_models";
+import { InteropZodType } from "@langchain/core/utils/types";
+import { SerializableSchema } from "@langchain/core/utils/standard_schema";
+import { AIMessageChunk, BaseMessage } from "@langchain/core/messages";
+import { ChatGenerationChunk, ChatResult } from "@langchain/core/outputs";
+import { BaseLanguageModelInput, StructuredOutputMethodOptions } from "@langchain/core/language_models/base";
+import { Embeddings, EmbeddingsParams } from "@langchain/core/embeddings";
+import { CallbackManagerForLLMRun } from "@langchain/core/callbacks/manager";
+import { ModelProfile } from "@langchain/core/language_models/profile";
+import { Runnable } from "@langchain/core/runnables";
+
+//#region src/types.d.ts
+/**
+ * Tools accepted by `ChatGoogleGenerativeAI`.
+ *
+ * In `@google/genai` the previously distinct tool shapes
+ * (`FunctionDeclarationsTool`, `CodeExecutionTool`,
+ * `GoogleSearchRetrievalTool`, ...) have all been folded into a single
+ * `Tool` interface whose fields (`functionDeclarations`, `codeExecution`,
+ * `googleSearch`/`googleSearchRetrieval`, ...) are individually optional.
+ */
+type GoogleGenerativeAIToolType = BindToolsInput | Tool;
+type GoogleGenerativeAIThinkingConfig = {
+  /** Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. */includeThoughts?: boolean; /** The number of thoughts tokens that the model should generate. */
+  thinkingBudget?: number; /** Optional. The level of thoughts tokens that the model should generate. */
+  thinkingLevel?: GoogleGenerativeAIThinkingLevel;
+};
+type GoogleGenerativeAIThinkingLevel = "THINKING_LEVEL_UNSPECIFIED" | "MINIMAL" | "LOW" | "MEDIUM" | "HIGH";
+//#endregion
+//#region src/chat_models.d.ts
+type BaseMessageExamplePair = {
+  input: BaseMessage;
+  output: BaseMessage;
+};
+interface GoogleGenerativeAIChatCallOptions extends BaseChatModelCallOptions {
+  tools?: GoogleGenerativeAIToolType[];
+  /**
+   * Allowed functions to call when the mode is "any".
+   * If empty, any one of the provided functions are called.
+   */
+  allowedFunctionNames?: string[];
+  /**
+   * Whether or not to include usage data, like token counts
+   * in the streamed response chunks.
+   * @default true
+   */
+  streamUsage?: boolean;
+  /**
+   * JSON schema to be returned by the model.
+   */
+  responseSchema?: Schema;
+}
+/**
+ * An interface defining the input to the ChatGoogleGenerativeAI class.
+ */
+interface GoogleGenerativeAIChatInput extends BaseChatModelParams, Pick<GoogleGenerativeAIChatCallOptions, "streamUsage"> {
+  /**
+   * Model Name to use
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  model: string;
+  /**
+   * Controls the randomness of the output.
+   *
+   * Values can range from [0.0,2.0], inclusive. A value closer to 2.0
+   * will produce responses that are more varied and creative, while
+   * a value closer to 0.0 will typically result in less surprising
+   * responses from the model.
+   *
+   * Note: The default value varies by model
+   */
+  temperature?: number;
+  /**
+   * Maximum number of tokens to generate in the completion.
+   */
+  maxOutputTokens?: number;
+  /**
+   * Top-p changes how the model selects tokens for output.
+   *
+   * Tokens are selected from most probable to least until the sum
+   * of their probabilities equals the top-p value.
+   *
+   * For example, if tokens A, B, and C have a probability of
+   * .3, .2, and .1 and the top-p value is .5, then the model will
+   * select either A or B as the next token (using temperature).
+   *
+   * Note: The default value varies by model
+   */
+  topP?: number;
+  /**
+   * Top-k changes how the model selects tokens for output.
+   *
+   * A top-k of 1 means the selected token is the most probable among
+   * all tokens in the model's vocabulary (also called greedy decoding),
+   * while a top-k of 3 means that the next token is selected from
+   * among the 3 most probable tokens (using temperature).
+   *
+   * Note: The default value varies by model
+   */
+  topK?: number;
+  /**
+   * The set of character sequences (up to 5) that will stop output generation.
+   * If specified, the API will stop at the first appearance of a stop
+   * sequence.
+   *
+   * Note: The stop sequence will not be included as part of the response.
+   * Note: stopSequences is only supported for Gemini models
+   */
+  stopSequences?: string[];
+  /**
+   * A list of unique `SafetySetting` instances for blocking unsafe content. The API will block
+   * any prompts and responses that fail to meet the thresholds set by these settings. If there
+   * is no `SafetySetting` for a given `SafetyCategory` provided in the list, the API will use
+   * the default safety setting for that category.
+   */
+  safetySettings?: SafetySetting[];
+  /**
+   * Google API key to use
+   */
+  apiKey?: string;
+  /**
+   * Google API version to use
+   */
+  apiVersion?: string;
+  /**
+   * Google API base URL to use
+   */
+  baseUrl?: string;
+  /**
+   * Google API custom headers to use
+   */
+  customHeaders?: Record<string, string>;
+  /** Whether to stream the results or not */
+  streaming?: boolean;
+  /**
+   * Whether or not to force the model to respond with JSON.
+   * Available for `gemini-1.5` models and later.
+   * @default false
+   */
+  json?: boolean;
+  /**
+   * Whether or not model supports system instructions.
+   * The following models support system instructions:
+   * - All Gemini 1.5 Pro model versions
+   * - All Gemini 1.5 Flash model versions
+   * - Gemini 1.0 Pro version gemini-1.0-pro-002
+   */
+  convertSystemMessageToHumanContent?: boolean | undefined;
+  /**
+   * Optional. Config for thinking features. An error will be returned if this
+   * field is set for models that don't support thinking.
+   */
+  thinkingConfig?: GoogleGenerativeAIThinkingConfig;
+  /**
+   * Optional. The server-generated resource name of a cached content
+   * (e.g. `cachedContents/abc123`) created via the Google GenAI caches API.
+   * When set, it is sent as `config.cachedContent` on every request so the
+   * model reuses the cached tokens.
+   *
+   * Create one with the underlying SDK, for example:
+   * ```typescript
+   * import { GoogleGenAI } from "@google/genai";
+   * const ai = new GoogleGenAI({ apiKey });
+   * const cache = await ai.caches.create({ model, config: { contents, systemInstruction, ttl: "300s" } });
+   * const llm = new ChatGoogleGenerativeAI({ model, cachedContent: cache.name });
+   * ```
+   */
+  cachedContent?: string;
+}
+declare class ChatGoogleGenerativeAI extends BaseChatModel<GoogleGenerativeAIChatCallOptions, AIMessageChunk> implements GoogleGenerativeAIChatInput {
+  static lc_name(): string;
+  lc_serializable: boolean;
+  get lc_secrets(): {
+    [key: string]: string;
+  } | undefined;
+  lc_namespace: string[];
+  get lc_aliases(): {
+    apiKey: string;
+  };
+  model: string;
+  temperature?: number;
+  maxOutputTokens?: number;
+  topP?: number;
+  topK?: number;
+  stopSequences: string[];
+  safetySettings?: SafetySetting[];
+  apiKey?: string;
+  streaming: boolean;
+  json?: boolean;
+  streamUsage: boolean;
+  convertSystemMessageToHumanContent: boolean | undefined;
+  thinkingConfig?: GoogleGenerativeAIThinkingConfig;
+  cachedContent?: string;
+  private client;
+  get _isMultimodalModel(): boolean;
+  constructor(model: string, fields?: Omit<GoogleGenerativeAIChatInput, "model">);
+  constructor(fields: GoogleGenerativeAIChatInput);
+  get useSystemInstruction(): boolean;
+  get computeUseSystemInstruction(): boolean;
+  getLsParams(options: this["ParsedCallOptions"]): LangSmithParams;
+  _combineLLMOutput(): never[];
+  _llmType(): string;
+  bindTools(tools: GoogleGenerativeAIToolType[], kwargs?: Partial<GoogleGenerativeAIChatCallOptions>): Runnable<BaseLanguageModelInput, AIMessageChunk, GoogleGenerativeAIChatCallOptions>;
+  invocationParams(options?: this["ParsedCallOptions"]): GenerateContentConfig;
+  private _buildGenerateContentRequest;
+  _generate(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): Promise<ChatResult>;
+  _streamResponseChunks(messages: BaseMessage[], options: this["ParsedCallOptions"], runManager?: CallbackManagerForLLMRun): AsyncGenerator<ChatGenerationChunk>;
+  completionWithRetry(request: GenerateContentParameters, options?: this["ParsedCallOptions"]): Promise<GenerateContentResponse>;
+  /**
+   * Return profiling information for the model.
+   *
+   * Provides information about the model's capabilities and constraints,
+   * including token limits, multimodal support, and advanced features like
+   * tool calling and structured output.
+   *
+   * @returns {ModelProfile} An object describing the model's capabilities and constraints
+   *
+   * @example
+   * ```typescript
+   * const model = new ChatGoogleGenerativeAI({ model: "gemini-2.5-flash" });
+   * const profile = model.profile;
+   * console.log(profile.maxInputTokens); // 1048576
+   * console.log(profile.imageInputs); // true
+   * ```
+   */
+  get profile(): ModelProfile;
+  withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | SerializableSchema<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<false>): Runnable<BaseLanguageModelInput, RunOutput>;
+  withStructuredOutput<RunOutput extends Record<string, any> = Record<string, any>>(outputSchema: InteropZodType<RunOutput> | SerializableSchema<RunOutput> | Record<string, any>, config?: StructuredOutputMethodOptions<true>): Runnable<BaseLanguageModelInput, {
+    raw: BaseMessage;
+    parsed: RunOutput;
+  }>;
+}
+//#endregion
+//#region src/embeddings.d.ts
+/**
+ * Interface that extends EmbeddingsParams and defines additional
+ * parameters specific to the GoogleGenerativeAIEmbeddings class.
+ */
+interface GoogleGenerativeAIEmbeddingsParams extends EmbeddingsParams {
+  /**
+   * Model Name to use
+   *
+   * Alias for `model`
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  modelName?: string;
+  /**
+   * Model Name to use
+   *
+   * Note: The format must follow the pattern - `{model}`
+   */
+  model?: string;
+  /**
+   * Type of task for which the embedding will be used
+   *
+   * Note: currently only supported by `embedding-001` model
+   */
+  taskType?: string;
+  /**
+   * An optional title for the text. Only applicable when TaskType is
+   * `RETRIEVAL_DOCUMENT`
+   *
+   * Note: currently only supported by `embedding-001` model
+   */
+  title?: string;
+  /**
+   * Whether to strip new lines from the input text. Default to true
+   */
+  stripNewLines?: boolean;
+  /**
+   * Google API key to use
+   */
+  apiKey?: string;
+  /**
+   * Google API base URL to use
+   */
+  baseUrl?: string;
+}
+/**
+ * Class that extends the Embeddings class and provides methods for
+ * generating embeddings using the Google Palm API.
+ * @example
+ * ```typescript
+ * const model = new GoogleGenerativeAIEmbeddings({
+ *   apiKey: "<YOUR API KEY>",
+ *   modelName: "embedding-001",
+ * });
+ *
+ * // Embed a single query
+ * const res = await model.embedQuery(
+ *   "What would be a good company name for a company that makes colorful socks?"
+ * );
+ * console.log({ res });
+ *
+ * // Embed multiple documents
+ * const documentRes = await model.embedDocuments(["Hello world", "Bye bye"]);
+ * console.log({ documentRes });
+ * ```
+ */
+declare class GoogleGenerativeAIEmbeddings extends Embeddings implements GoogleGenerativeAIEmbeddingsParams {
+  apiKey?: string;
+  modelName: string;
+  model: string;
+  taskType?: string;
+  title?: string;
+  stripNewLines: boolean;
+  maxBatchSize: number;
+  private client;
+  constructor(fields?: GoogleGenerativeAIEmbeddingsParams);
+  private _cleanText;
+  private get _embedConfig();
+  protected _embedQueryContent(text: string): Promise<number[]>;
+  protected _embedDocumentsContent(documents: string[]): Promise<number[][]>;
+  /**
+   * Method that takes a document as input and returns a promise that
+   * resolves to an embedding for the document. It calls the _embedText
+   * method with the document as the input.
+   * @param document Document for which to generate an embedding.
+   * @returns Promise that resolves to an embedding for the input document.
+   */
+  embedQuery(document: string): Promise<number[]>;
+  /**
+   * Method that takes an array of documents as input and returns a promise
+   * that resolves to a 2D array of embeddings for each document. It calls
+   * the _embedText method for each document in the array.
+   * @param documents Array of documents for which to generate embeddings.
+   * @returns Promise that resolves to a 2D array of embeddings for each input document.
+   */
+  embedDocuments(documents: string[]): Promise<number[][]>;
+}
+//#endregion
+export { BaseMessageExamplePair, ChatGoogleGenerativeAI, GoogleGenerativeAIChatCallOptions, GoogleGenerativeAIChatInput, GoogleGenerativeAIEmbeddings, GoogleGenerativeAIEmbeddingsParams };
+//# sourceMappingURL=index.d.mts.map