@langchain/google 0.2.11 → 0.2.12

package/dist/chat_models/{api-types.d.cts → api_types/generate_content.d.ts}

@@ -1,5 +1,5 @@
-//#region src/chat_models/api-types.d.ts
-export declare namespace Gemini {
+//#region src/chat_models/api_types/generate_content.d.ts
+export declare namespace GenContent {
   /**
    * Safety setting, affecting the safety-blocking behavior.
    *
@@ -335,7 +335,7 @@ export declare namespace Gemini {
      * Optional. 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 dependent on the number of times the
+     * This penalty is binary on/off and not dependant on the number of times the
      * token is used (after the first). Use
      * frequency_penalty
      * for a penalty that increases with each use.
@@ -387,7 +387,7 @@ export declare namespace Gemini {
      * Refer to the [JSON text generation
      * guide](https://ai.google.dev/gemini-api/docs/json-mode) for more details.
      */
-    responseSchema?: Gemini.Tools.Schema;
+    responseSchema?: GenContent.Tools.Schema;
     /**
      * Optional. Seed used in decoding. If not set, the request uses a randomly generated
      * seed.
@@ -712,15 +712,20 @@ export declare namespace Gemini {
       type: Type;
     }
     /**
-     * Different types of search that can be enabled on the GoogleSearch tool.
+     * An object that represents a latitude/longitude pair. This is expressed as a
+     * pair of doubles to represent degrees latitude and degrees longitude. Unless
+     * specified otherwise, this object must conform to the
+     * WGS84 standard. Values must be within normalized ranges.
      */
-    interface SearchTypes {
-      /** Optional. Enables image search. Image bytes are returned. */
-      imageSearch?: ImageSearch;
+    interface LatLng {
       /**
-       * Optional. Enables web search. Only text results are returned.
+       * The latitude in degrees. It must be in the range [-90.0, +90.0].
        */
-      webSearch?: WebSearch;
+      latitude?: number;
+      /**
+       * The longitude in degrees. It must be in the range [-180.0, +180.0].
+       */
+      longitude?: number;
     }
     /**
      * Represents a time interval, encoded as a Timestamp start (inclusive) and a
@@ -747,28 +752,23 @@ export declare namespace Gemini {
       startTime?: string;
     }
     /**
-     * An object that represents a latitude/longitude pair. This is expressed as a
-     * pair of doubles to represent degrees latitude and degrees longitude. Unless
-     * specified otherwise, this object must conform to the
-     * WGS84 standard. Values must be within normalized ranges.
+     * Different types of search that can be enabled on the GoogleSearch tool.
      */
-    interface LatLng {
-      /**
-       * The latitude in degrees. It must be in the range [-90.0, +90.0].
-       */
-      latitude?: number;
+    interface SearchTypes {
+      /** Optional. Enables image search. Image bytes are returned. */
+      imageSearch?: ImageSearch;
       /**
-       * The longitude in degrees. It must be in the range [-180.0, +180.0].
+       * Optional. Enables web search. Only text results are returned.
        */
-      longitude?: number;
+      webSearch?: WebSearch;
     }
     type Type = "TYPE_UNSPECIFIED" | "STRING" | "NUMBER" | "INTEGER" | "BOOLEAN" | "ARRAY" | "OBJECT" | "NULL" | (string & {});
-    /** Image search for grounding and related configurations. */
-    interface ImageSearch {}
     /**
      * Standard web search for grounding and related configurations.
      */
     interface WebSearch {}
+    /** Image search for grounding and related configurations. */
+    interface ImageSearch {}
   }
   /** Request to generate a completion from the model. */
   interface GenerateContentRequest {
@@ -835,7 +835,7 @@ export declare namespace Gemini {
      * guide](https://ai.google.dev/gemini-api/docs/function-calling#function_calling_mode)
      * for a usage example.
      */
-    toolConfig?: Gemini.Tools.ToolConfig;
+    toolConfig?: GenContent.Tools.ToolConfig;
     /**
      * Optional. A list of `Tools` the `Model` may use to generate the next response.
      *
@@ -1227,66 +1227,26 @@ export declare namespace Gemini {
      */
     readonly usageMetadata?: UsageMetadata;
   }
-  /**
-   * A grounding chunk from Google Maps. A Maps chunk corresponds to a single
-   * place.
-   */
-  interface Maps {
-    /**
-     * Sources that provide answers about the features of a given place in
-     * Google Maps.
-     */
-    placeAnswerSources?: PlaceAnswerSources;
-    /**
-     * The ID of the place, in `places/{place_id}` format. A user can use this
-     * ID to look up that place.
-     */
-    placeId?: string;
-    /** Text description of the place answer. */
-    text?: string;
-    /** Title of the place. */
-    title?: string;
-    /** URI reference of the place. */
-    uri?: string;
-  }
-  /** User provided metadata about the GroundingFact. */
-  interface GroundingChunkCustomMetadata {
-    /** The key of the metadata. */
-    key?: string;
+  /** A citation to a source for a portion of a specific response. */
+  interface CitationSource {
+    /** Optional. End of the attributed segment, exclusive. */
+    endIndex?: number;
     /**
-     * Optional. The numeric value of the metadata.
-     * The expected range for this value depends on the specific `key` used.
+     * Optional. License for the GitHub project that is attributed as a source for segment.
+     *
+     * License info is required for code citations.
      */
-    numericValue?: number;
-    /** Optional. A list of string values for the metadata. */
-    stringListValue?: GroundingChunkStringList;
-    /** Optional. The string value of the metadata. */
-    stringValue?: string;
-  }
-  type ServiceTier = "unspecified" | "standard" | "flex" | "priority" | (string & {});
-  /**
-   * Optional. If specified, the media resolution specified will be used.
-   */
-  type MediaResolution = "MEDIA_RESOLUTION_UNSPECIFIED" | "MEDIA_RESOLUTION_LOW" | "MEDIA_RESOLUTION_MEDIUM" | "MEDIA_RESOLUTION_HIGH" | (string & {});
-  /**
-   * The output from a server-side `ToolCall` execution. This message contains
-   * the results of a tool invocation that was initiated by a `ToolCall`
-   * from the model. The client should pass this `ToolResponse` back to the API
-   * in a subsequent turn within a `Content` message, along with the corresponding
-   * `ToolCall`.
-   */
-  interface ToolResponse {
+    license?: string;
     /**
-     * Optional. The identifier of the tool call this response is for.
+     * Optional. Start of segment of the response that is attributed to this source.
+     *
+     * Index indicates the start of the segment, measured in bytes.
      */
-    id?: string;
-    /** Optional. The tool response. */
-    response?: Record<string, unknown>;
+    startIndex?: number;
     /**
-     * Required. The type of tool that was called, matching the `tool_type` in the
-     * corresponding `ToolCall`.
+     * Optional. URI that is attributed as a source for a portion of the text.
      */
-    toolType: ToolType;
+    uri?: string;
   }
   /** Chunk from image search. */
   interface Image {
@@ -1302,25 +1262,11 @@ export declare namespace Gemini {
     /** The title of the web page that the image is from. */
     title?: string;
   }
-  /** Chunk from the web. */
-  interface Web {
-    /** Output only. Title of the chunk. */
-    readonly title?: string;
-    /** Output only. URI reference of the chunk. */
-    readonly uri?: string;
-  }
   /** The configuration for the prebuilt speaker to use. */
   interface PrebuiltVoiceConfig {
     /** The name of the preset voice to use. */
     voiceName?: string;
   }
-  /** URI based data. */
-  interface FileData {
-    /** Required. URI. */
-    fileUri: string;
-    /** Optional. The IANA standard MIME type of the source data. */
-    mimeType?: string;
-  }
   /**
    * The result output from a `FunctionCall` that contains a string
    * representing the `FunctionDeclaration.name` and a structured JSON
@@ -1371,27 +1317,7 @@ export declare namespace Gemini {
      */
     willContinue?: boolean;
   }
-  /** Google search entry point. */
-  interface SearchEntryPoint {
-    /**
-     * Optional. Web content snippet that can be embedded in a web page or an app webview.
-     */
-    renderedContent?: string;
-    /** Optional. Base64 encoded JSON representing array of  tuple. */
-    sdkBlob?: string;
-  }
-  /**
-   * The status of the underlying model. This is used to indicate the stage of the
-   * underlying model and the retirement time if applicable.
-   */
-  interface ModelStatus {
-    /** A message explaining the model status. */
-    message?: string;
-    /** The stage of the underlying model. */
-    modelStage?: ModelStage;
-    /** The time at which the model will be retired. */
-    retirementTime?: string;
-  }
+  type ServiceTier = "unspecified" | "standard" | "flex" | "priority" | (string & {});
   /**
    * Tool details that the model may use to generate response.
    *
@@ -1405,18 +1331,18 @@ export declare namespace Gemini {
     /**
      * Optional. Enables the model to execute code as part of generation.
      */
-    codeExecution?: Gemini.Tools.CodeExecution;
+    codeExecution?: GenContent.Tools.CodeExecution;
     /**
      * Optional. Tool to support the model interacting directly with the computer.
      * If enabled, it automatically populates computer-use specific Function
      * Declarations.
      */
-    computerUse?: Gemini.Tools.ComputerUse;
+    computerUse?: GenContent.Tools.ComputerUse;
     /**
      * Optional. FileSearch tool type.
      * Tool to retrieve knowledge from Semantic Retrieval corpora.
      */
-    fileSearch?: Gemini.Tools.FileSearch;
+    fileSearch?: GenContent.Tools.FileSearch;
     /**
      * Optional. A list of `FunctionDeclarations` available to the model that can be used
      * for function calling.
@@ -1431,66 +1357,37 @@ export declare namespace Gemini {
      * with the Content.role "function" generation context for the next model
      * turn.
      */
-    functionDeclarations?: Array<Gemini.Tools.FunctionDeclaration>;
+    functionDeclarations?: Array<GenContent.Tools.FunctionDeclaration>;
     /**
      * Optional. Tool that allows grounding the model's response with geospatial context
      * related to the user's query.
      */
-    googleMaps?: Gemini.Tools.GoogleMaps;
+    googleMaps?: GenContent.Tools.GoogleMaps;
     /**
      * Optional. GoogleSearch tool type.
      * Tool to support Google Search in Model. Powered by Google.
      */
-    googleSearch?: Gemini.Tools.GoogleSearch;
+    googleSearch?: GenContent.Tools.GoogleSearch;
     /** Optional. Retrieval tool that is powered by Google search. */
     googleSearchRetrieval?: GoogleSearchRetrieval;
     /** Optional. MCP Servers to connect to. */
     mcpServers?: Array<McpServer>;
     /** Optional. Tool to support URL context retrieval. */
-    urlContext?: Gemini.Tools.UrlContext;
-  }
-  /** A citation to a source for a portion of a specific response. */
-  interface CitationSource {
-    /** Optional. End of the attributed segment, exclusive. */
-    endIndex?: number;
-    /**
-     * Optional. License for the GitHub project that is attributed as a source for segment.
-     *
-     * License info is required for code citations.
-     */
-    license?: string;
-    /**
-     * Optional. Start of segment of the response that is attributed to this source.
-     *
-     * Index indicates the start of the segment, measured in bytes.
-     */
-    startIndex?: number;
-    /**
-     * Optional. URI that is attributed as a source for a portion of the text.
-     */
-    uri?: string;
+    urlContext?: GenContent.Tools.UrlContext;
   }
-  /**
-   * A predicted `FunctionCall` returned from the model that contains
-   * a string representing the `FunctionDeclaration.name` with the
-   * arguments and their values.
-   */
-  interface FunctionCall {
-    /**
-     * Optional. The function parameters and values in JSON object format.
-     */
-    args?: Record<string, unknown>;
-    /**
-     * Optional. Unique identifier of the function call. If populated, the client to
-     * execute the `function_call` and return the response with the matching `id`.
-     */
-    id?: string;
+  /** User provided metadata about the GroundingFact. */
+  interface GroundingChunkCustomMetadata {
+    /** The key of the metadata. */
+    key?: string;
     /**
-     * Required. The name of the function to call.
-     * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
-     * length of 128.
+     * Optional. The numeric value of the metadata.
+     * The expected range for this value depends on the specific `key` used.
      */
-    name: string;
+    numericValue?: number;
+    /** Optional. A list of string values for the metadata. */
+    stringListValue?: GroundingChunkStringList;
+    /** Optional. The string value of the metadata. */
+    stringValue?: string;
   }
   /**
    * Raw media bytes.
@@ -1511,6 +1408,61 @@ export declare namespace Gemini {
      */
     mimeType?: string;
   }
+  /**
+   * The output from a server-side `ToolCall` execution. This message contains
+   * the results of a tool invocation that was initiated by a `ToolCall`
+   * from the model. The client should pass this `ToolResponse` back to the API
+   * in a subsequent turn within a `Content` message, along with the corresponding
+   * `ToolCall`.
+   */
+  interface ToolResponse {
+    /**
+     * Optional. The identifier of the tool call this response is for.
+     */
+    id?: string;
+    /** Optional. The tool response. */
+    response?: Record<string, unknown>;
+    /**
+     * Required. The type of tool that was called, matching the `tool_type` in the
+     * corresponding `ToolCall`.
+     */
+    toolType: ToolType;
+  }
+  /** Google search entry point. */
+  interface SearchEntryPoint {
+    /**
+     * Optional. Web content snippet that can be embedded in a web page or an app webview.
+     */
+    renderedContent?: string;
+    /** Optional. Base64 encoded JSON representing array of  tuple. */
+    sdkBlob?: string;
+  }
+  /** Chunk from the web. */
+  interface Web {
+    /** Output only. Title of the chunk. */
+    readonly title?: string;
+    /** Output only. URI reference of the chunk. */
+    readonly uri?: string;
+  }
+  /**
+   * The status of the underlying model. This is used to indicate the stage of the
+   * underlying model and the retirement time if applicable.
+   */
+  interface ModelStatus {
+    /** A message explaining the model status. */
+    message?: string;
+    /** The stage of the underlying model. */
+    modelStage?: ModelStage;
+    /** The time at which the model will be retired. */
+    retirementTime?: string;
+  }
+  /** URI based data. */
+  interface FileData {
+    /** Required. URI. */
+    fileUri: string;
+    /** Optional. The IANA standard MIME type of the source data. */
+    mimeType?: string;
+  }
   /**
    * A predicted server-side `ToolCall` returned from the model. This message
    * contains information about a tool that the model wants to invoke.
@@ -1532,13 +1484,61 @@ export declare namespace Gemini {
     /** Required. The type of tool that was called. */
     toolType: ToolType;
   }
-  /** A list of string values. */
-  interface GroundingChunkStringList {
-    /** The string values of the list. */
-    values?: Array<string>;
+  /**
+   * A grounding chunk from Google Maps. A Maps chunk corresponds to a single
+   * place.
+   */
+  interface Maps {
+    /**
+     * Sources that provide answers about the features of a given place in
+     * Google Maps.
+     */
+    placeAnswerSources?: PlaceAnswerSources;
+    /**
+     * The ID of the place, in `places/{place_id}` format. A user can use this
+     * ID to look up that place.
+     */
+    placeId?: string;
+    /** Text description of the place answer. */
+    text?: string;
+    /** Title of the place. */
+    title?: string;
+    /** URI reference of the place. */
+    uri?: string;
+  }
+  /**
+   * A predicted `FunctionCall` returned from the model that contains
+   * a string representing the `FunctionDeclaration.name` with the
+   * arguments and their values.
+   */
+  interface FunctionCall {
+    /**
+     * Optional. The function parameters and values in JSON object format.
+     */
+    args?: Record<string, unknown>;
+    /**
+     * Optional. Unique identifier of the function call. If populated, the client to
+     * execute the `function_call` and return the response with the matching `id`.
+     */
+    id?: string;
+    /**
+     * Required. The name of the function to call.
+     * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
+     * length of 128.
+     */
+    name: string;
+  }
+  /**
+   * A MCPServer is a server that can be called by the model to perform actions.
+   * It is a server that implements the MCP protocol.
+   * Next ID: 5
+   */
+  interface McpServer {
+    /** The name of the MCPServer. */
+    name?: string;
+    /** A transport that can stream HTTP requests and responses. */
+    streamableHttpTransport?: StreamableHttpTransport;
   }
-  /** Required. The type of tool that was called. */
-  type ToolType = "TOOL_TYPE_UNSPECIFIED" | "GOOGLE_SEARCH_WEB" | "GOOGLE_SEARCH_IMAGE" | "URL_CONTEXT" | "GOOGLE_MAPS" | "FILE_SEARCH" | (string & {});
   /**
    * A datatype containing media that is part of a `FunctionResponse` message.
    *
@@ -1554,17 +1554,7 @@ export declare namespace Gemini {
     /** Inline media bytes. */
     inlineData?: FunctionResponseBlob;
   }
-  /**
-   * A MCPServer is a server that can be called by the model to perform actions.
-   * It is a server that implements the MCP protocol.
-   * Next ID: 5
-   */
-  interface McpServer {
-    /** The name of the MCPServer. */
-    name?: string;
-    /** A transport that can stream HTTP requests and responses. */
-    streamableHttpTransport?: StreamableHttpTransport;
-  }
+  type ModelStage = "MODEL_STAGE_UNSPECIFIED" | "UNSTABLE_EXPERIMENTAL" | "EXPERIMENTAL" | "PREVIEW" | "STABLE" | "LEGACY" | "DEPRECATED" | "RETIRED" | (string & {});
   /**
    * Collection of sources that provide answers about the features of a given
    * place in Google Maps. Each PlaceAnswerSources message corresponds to a
@@ -1580,7 +1570,11 @@ export declare namespace Gemini {
      */
     reviewSnippets?: Array<ReviewSnippet>;
   }
-  type ModelStage = "MODEL_STAGE_UNSPECIFIED" | "UNSTABLE_EXPERIMENTAL" | "EXPERIMENTAL" | "PREVIEW" | "STABLE" | "LEGACY" | "DEPRECATED" | "RETIRED" | (string & {});
+  /** A list of string values. */
+  interface GroundingChunkStringList {
+    /** The string values of the list. */
+    values?: Array<string>;
+  }
   /**
    * Tool to retrieve public web data for grounding, powered by Google.
    */
@@ -1590,26 +1584,6 @@ export declare namespace Gemini {
      */
     dynamicRetrievalConfig?: DynamicRetrievalConfig;
   }
-  /**
-   * Raw media bytes for function response.
-   *
-   * Text should not be sent as raw bytes, use the 'FunctionResponse.response'
-   * field.
-   */
-  interface FunctionResponseBlob {
-    /** Raw bytes for media formats. */
-    data?: string;
-    /**
-     * The IANA standard MIME type of the source data.
-     * Examples:
-     *   - image/png
-     *   - image/jpeg
-     * If an unsupported MIME type is provided, an error will be returned. For a
-     * complete list of supported types, see [Supported file
-     * formats](https://ai.google.dev/gemini-api/docs/prompting_with_media#supported_file_formats).
-     */
-    mimeType?: string;
-  }
   /**
    * A transport that can stream HTTP requests and responses.
    * Next ID: 6
@@ -1633,6 +1607,26 @@ export declare namespace Gemini {
      */
     url?: string;
   }
+  /**
+   * Raw media bytes for function response.
+   *
+   * Text should not be sent as raw bytes, use the 'FunctionResponse.response'
+   * field.
+   */
+  interface FunctionResponseBlob {
+    /** Raw bytes for media formats. */
+    data?: string;
+    /**
+     * The IANA standard MIME type of the source data.
+     * Examples:
+     *   - image/png
+     *   - image/jpeg
+     * If an unsupported MIME type is provided, an error will be returned. For a
+     * complete list of supported types, see [Supported file
+     * formats](https://ai.google.dev/gemini-api/docs/prompting_with_media#supported_file_formats).
+     */
+    mimeType?: string;
+  }
   /**
    * Encapsulates a snippet of a user review that answers a question about
    * the features of a specific place in Google Maps.
@@ -1655,6 +1649,12 @@ export declare namespace Gemini {
     /** The mode of the predictor to be used in dynamic retrieval. */
     mode?: "MODE_UNSPECIFIED" | "MODE_DYNAMIC" | (string & {});
   }
+  /**
+   * Optional. If specified, the media resolution specified will be used.
+   */
+  type MediaResolution = "MEDIA_RESOLUTION_UNSPECIFIED" | "MEDIA_RESOLUTION_LOW" | "MEDIA_RESOLUTION_MEDIUM" | "MEDIA_RESOLUTION_HIGH" | (string & {});
+  /** Required. The type of tool that was called. */
+  type ToolType = "TOOL_TYPE_UNSPECIFIED" | "GOOGLE_SEARCH_WEB" | "GOOGLE_SEARCH_IMAGE" | "URL_CONTEXT" | "GOOGLE_MAPS" | "FILE_SEARCH" | (string & {});
 }
 //#endregion
-//# sourceMappingURL=api-types.d.cts.map
+//# sourceMappingURL=generate_content.d.ts.map