@google/genai 1.8.0 → 1.10.0

package/README.md

@@ -218,10 +218,10 @@ main();
 
 ### Function Calling
 
-To let Gemini to interact with external systems, you can provide provide
+To let Gemini to interact with external systems, you can provide
 `functionDeclaration` objects as `tools`. To use these tools it's a 4 step
 
-1. **Declare the function name, description, and parameters**
+1. **Declare the function name, description, and parametersJsonSchema**
 2. **Call `generateContent` with function calling enabled**
 3. **Use the returned `FunctionCall` parameters to call your actual function**
 3. **Send the result back to the model (with history, easier in `ai.chat`)
@@ -234,19 +234,14 @@ const GEMINI_API_KEY = process.env.GEMINI_API_KEY;
 async function main() {
   const controlLightDeclaration: FunctionDeclaration = {
     name: 'controlLight',
-    parameters: {
-      type: Type.OBJECT,
-      description: 'Set the brightness and color temperature of a room light.',
-      properties: {
+    parametersJsonSchema: {
+      type: 'object',
+      properties:{
         brightness: {
-          type: Type.NUMBER,
-          description:
-              'Light level from 0 to 100. Zero is off and 100 is full brightness.',
+          type:'number',
         },
         colorTemperature: {
-          type: Type.STRING,
-          description:
-              'Color temperature of the light fixture which can be `daylight`, `cool`, or `warm`.',
+          type:'string',
         },
       },
       required: ['brightness', 'colorTemperature'],

package/dist/genai.d.ts

@@ -560,6 +560,8 @@ export declare interface BatchJobDestination {
     inlinedResponses?: InlinedResponse[];
 }
 
+export declare type BatchJobDestinationUnion = BatchJobDestination | string;
+
 /** Config for `src` parameter. */
 export declare interface BatchJobSource {
     /** Storage format of the input files. Must be one of:
@@ -1229,7 +1231,7 @@ export declare interface CreateBatchJobConfig {
     /** GCS or BigQuery URI prefix for the output predictions. Example:
      "gs://path/to/output/data" or "bq://projectId.bqDatasetId.bqTableId".
      */
-    dest?: string;
+    dest?: BatchJobDestinationUnion;
 }
 
 /** Config for batches.create parameters. */
@@ -1745,6 +1747,9 @@ export declare interface EditImageConfig {
      only).
      */
     outputCompressionQuality?: number;
+    /** Whether to add a watermark to the generated images.
+     */
+    addWatermark?: boolean;
     /** Describes the editing mode for the request. */
     editMode?: EditMode;
     /** The number of sampling steps. A higher value has better image
@@ -2480,6 +2485,8 @@ export declare interface GenerateContentParameters {
 
 /** Response message for PredictionService.GenerateContent. */
 export declare class GenerateContentResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Response variations returned by the model.
      */
     candidates?: Candidate[];
@@ -2800,7 +2807,7 @@ export declare interface GenerateVideosConfig {
     seed?: number;
     /** The aspect ratio for the generated video. 16:9 (landscape) and 9:16 (portrait) are supported. */
     aspectRatio?: string;
-    /** The resolution for the generated video. 1280x720, 1920x1080 are supported. */
+    /** The resolution for the generated video. 720p and 1080p are supported. */
     resolution?: string;
     /** Whether allow to generate person videos, and restrict to specific ages. Supported values are: dont_allow, allow_adult. */
     personGeneration?: string;
@@ -3415,7 +3422,10 @@ export declare interface HttpOptions {
     headers?: Record<string, string>;
     /** Timeout for the request in milliseconds. */
     timeout?: number;
-    /** Extra parameters to add to the request body. */
+    /** Extra parameters to add to the request body.
+     The structure must match the backend API's request structure.
+     - VertexAI backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest
+     - GeminiAPI backend API docs: https://ai.google.dev/api/rest */
     extraBody?: Record<string, unknown>;
 }
 
@@ -3498,11 +3508,38 @@ export { Image_2 as Image }
 
 /** Enum that specifies the language of the text in the prompt. */
 export declare enum ImagePromptLanguage {
+    /**
+     * Auto-detect the language.
+     */
     auto = "auto",
+    /**
+     * English
+     */
     en = "en",
+    /**
+     * Japanese
+     */
     ja = "ja",
+    /**
+     * Korean
+     */
     ko = "ko",
-    hi = "hi"
+    /**
+     * Hindi
+     */
+    hi = "hi",
+    /**
+     * Chinese
+     */
+    zh = "zh",
+    /**
+     * Portuguese
+     */
+    pt = "pt",
+    /**
+     * Spanish
+     */
+    es = "es"
 }
 
 /** Config for inlined request. */
@@ -3800,7 +3837,7 @@ export declare class Live {
      if (GOOGLE_GENAI_USE_VERTEXAI) {
      model = 'gemini-2.0-flash-live-preview-04-09';
      } else {
-     model = 'gemini-2.0-flash-live-001';
+     model = 'gemini-live-2.5-flash-preview';
      }
      const session = await ai.live.connect({
      model: model,
@@ -4766,6 +4803,14 @@ export declare class Models extends BaseModule {
      * ```
      */
     generateContent: (params: types.GenerateContentParameters) => Promise<types.GenerateContentResponse>;
+    /**
+     * This logic is needed for GenerateContentConfig only.
+     * Previously we made GenerateContentConfig.responseSchema field to accept
+     * unknown. Since v1.9.0, we switch to use backend JSON schema support.
+     * To maintain backward compatibility, we move the data that was treated as
+     * JSON schema from the responseSchema field to the responseJsonSchema field.
+     */
+    private maybeMoveToResponseJsonSchem;
     /**
      * Makes an API request to generate content with a given model and yields the
      * response in chunks.
@@ -5040,18 +5085,6 @@ export declare interface MultiSpeakerVoiceConfig {
     speakerVoiceConfigs?: SpeakerVoiceConfig[];
 }
 
-/** A long-running operation. */
-export declare interface Operation {
-    /** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
-    name?: string;
-    /** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.  Any method that returns a long-running operation should document the metadata type, if any. */
-    metadata?: Record<string, unknown>;
-    /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
-    done?: boolean;
-    /** The error result of the operation in case of failure or cancellation. */
-    error?: Record<string, unknown>;
-}
-
 /** Parameters for the get method of the operations module. */
 export declare interface OperationGetParameters {
     /** The operation to be retrieved. */
@@ -5778,7 +5811,7 @@ export declare class Session {
      if (GOOGLE_GENAI_USE_VERTEXAI) {
      model = 'gemini-2.0-flash-live-preview-04-09';
      } else {
-     model = 'gemini-2.0-flash-live-001';
+     model = 'gemini-live-2.5-flash-preview';
      }
      const session = await ai.live.connect({
      model: model,
@@ -6073,14 +6106,20 @@ export declare class Tokens extends BaseModule {
      * @experimental
      *
      * @remarks
-     * Ephermeral auth tokens is only supported in the Gemini Developer API.
+     * Ephemeral auth tokens is only supported in the Gemini Developer API.
      * It can be used for the session connection to the Live constrained API.
+     * Support in v1alpha only.
      *
      * @param params - The parameters for the create request.
      * @return The created auth token.
      *
      * @example
      * ```ts
+     * const ai = new GoogleGenAI({
+     *     apiKey: token.name,
+     *     httpOptions: { apiVersion: 'v1alpha' }  // Support in v1alpha only.
+     * });
+     *
      * // Case 1: If LiveEphemeralParameters is unset, unlock LiveConnectConfig
      * // when using the token in Live API sessions. Each session connection can
      * // use a different configuration.
@@ -6345,6 +6384,18 @@ export declare interface TuningJob {
     tunedModelDisplayName?: string;
 }
 
+/** A long-running operation. */
+export declare interface TuningOperation {
+    /** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
+    name?: string;
+    /** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.  Any method that returns a long-running operation should document the metadata type, if any. */
+    metadata?: Record<string, unknown>;
+    /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
+    done?: boolean;
+    /** The error result of the operation in case of failure or cancellation. */
+    error?: Record<string, unknown>;
+}
+
 declare class Tunings extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
@@ -6662,7 +6713,7 @@ declare namespace types {
         TuningValidationDataset,
         CreateTuningJobConfig,
         CreateTuningJobParameters,
-        Operation,
+        TuningOperation,
         CreateCachedContentConfig,
         CreateCachedContentParameters,
         CachedContentUsageMetadata,
@@ -6791,7 +6842,8 @@ declare namespace types {
         ToolUnion,
         ToolListUnion,
         DownloadableFileUnion,
-        BatchJobSourceUnion
+        BatchJobSourceUnion,
+        BatchJobDestinationUnion
     }
 }