@google/genai 1.9.0 → 1.11.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[];
@@ -2748,6 +2755,10 @@ export declare interface GenerateImagesConfig {
     /** Whether to add a watermark to the generated images.
      */
     addWatermark?: boolean;
+    /** The size of the largest dimension of the generated image.
+     Supported sizes are 1K and 2K (not supported for Imagen 3 models).
+     */
+    imageSize?: string;
     /** Whether to use the prompt rewriting logic.
      */
     enhancePrompt?: boolean;
@@ -2800,7 +2811,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;
@@ -2818,8 +2829,8 @@ export declare interface GenerateVideosConfig {
     compressionQuality?: VideoCompressionQuality;
 }
 
-/** A video generation operation. */
-export declare interface GenerateVideosOperation {
+/** A video generation long-running operation. */
+export declare class GenerateVideosOperation implements Operation<GenerateVideosResponse> {
     /** 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. */
@@ -2828,8 +2839,13 @@ export declare interface GenerateVideosOperation {
     done?: boolean;
     /** The error result of the operation in case of failure or cancellation. */
     error?: Record<string, unknown>;
-    /** The generated videos. */
+    /** The response if the operation is successful. */
     response?: GenerateVideosResponse;
+    /**
+     * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
+     * @internal
+     */
+    _fromAPIResponse({ apiResponse, isVertexAI, }: OperationFromAPIResponseParameters): Operation<GenerateVideosResponse>;
 }
 
 /** Class that represents the parameters for generating videos. */
@@ -3415,7 +3431,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>;
 }
 
@@ -3680,6 +3699,8 @@ export declare interface ListBatchJobsParameters {
 
 /** Config for batches.list return value. */
 export declare class ListBatchJobsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     nextPageToken?: string;
     batchJobs?: BatchJob[];
 }
@@ -3707,6 +3728,8 @@ export declare interface ListCachedContentsParameters {
 }
 
 export declare class ListCachedContentsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     nextPageToken?: string;
     /** List of cached contents.
      */
@@ -3736,6 +3759,8 @@ export declare interface ListFilesParameters {
 
 /** Response for the list files method. */
 export declare class ListFilesResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** A token to retrieve next page of results. */
     nextPageToken?: string;
     /** The list of files. */
@@ -3764,6 +3789,8 @@ export declare interface ListModelsParameters {
 }
 
 export declare class ListModelsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     nextPageToken?: string;
     models?: Model[];
 }
@@ -3791,6 +3818,8 @@ export declare interface ListTuningJobsParameters {
 
 /** Response for the list tuning jobs method. */
 export declare class ListTuningJobsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page. */
     nextPageToken?: string;
     /** List of TuningJobs in the requested page. */
@@ -4849,7 +4878,7 @@ export declare class Models extends BaseModule {
      * modify the original params. Also sets the MCP usage header if there are
      * MCP tools in the parameters.
      */
-    private processParamsForMcpUsage;
+    private processParamsMaybeAddMcpUsage;
     private initAfcToolsMap;
     private processAfcStream;
     /**
@@ -4915,6 +4944,30 @@ export declare class Models extends BaseModule {
      * ```
      */
     upscaleImage: (params: types.UpscaleImageParameters) => Promise<types.UpscaleImageResponse>;
+    /**
+     *  Generates videos based on a text description and configuration.
+     *
+     * @param params - The parameters for generating videos.
+     * @return A Promise<GenerateVideosOperation> which allows you to track the progress and eventually retrieve the generated videos using the operations.get method.
+     *
+     * @example
+     * ```ts
+     * const operation = await ai.models.generateVideos({
+     *  model: 'veo-2.0-generate-001',
+     *  prompt: 'A neon hologram of a cat driving at top speed',
+     *  config: {
+     *    numberOfVideos: 1
+     * });
+     *
+     * while (!operation.done) {
+     *   await new Promise(resolve => setTimeout(resolve, 10000));
+     *   operation = await ai.operations.getVideosOperation({operation: operation});
+     * }
+     *
+     * console.log(operation.response?.generatedVideos?.[0]?.video?.uri);
+     * ```
+     */
+    generateVideos: (params: types.GenerateVideosParameters) => Promise<types.GenerateVideosOperation>;
     private generateContentInternal;
     private generateContentStreamInternal;
     /**
@@ -5060,7 +5113,7 @@ export declare class Models extends BaseModule {
      * console.log(operation.response?.generatedVideos?.[0]?.video?.uri);
      * ```
      */
-    generateVideos(params: types.GenerateVideosParameters): Promise<types.GenerateVideosOperation>;
+    private generateVideosInternal;
 }
 
 /** Config for model selection. */
@@ -5076,7 +5129,7 @@ export declare interface MultiSpeakerVoiceConfig {
 }
 
 /** A long-running operation. */
-export declare interface Operation {
+export declare interface Operation<T> {
     /** 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. */
@@ -5085,12 +5138,27 @@ export declare interface Operation {
     done?: boolean;
     /** The error result of the operation in case of failure or cancellation. */
     error?: Record<string, unknown>;
+    /** The response if the operation is successful. */
+    response?: T;
+    /**
+     * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
+     * @internal
+     */
+    _fromAPIResponse({ apiResponse, isVertexAI, }: OperationFromAPIResponseParameters): Operation<T>;
+}
+
+/** Parameters of the fromAPIResponse method of the Operation class. */
+export declare interface OperationFromAPIResponseParameters {
+    /** The API response to be converted to an Operation. */
+    apiResponse: Record<string, unknown>;
+    /** Whether the API response is from Vertex AI. */
+    isVertexAI: boolean;
 }
 
 /** Parameters for the get method of the operations module. */
-export declare interface OperationGetParameters {
+export declare interface OperationGetParameters<T, U extends Operation<T>> {
     /** The operation to be retrieved. */
-    operation: GenerateVideosOperation;
+    operation: U;
     /** Used to override the default configuration. */
     config?: GetOperationConfig;
 }
@@ -5104,7 +5172,14 @@ export declare class Operations extends BaseModule {
      * @param parameters The parameters for the get operation request.
      * @return The updated Operation object, with the latest status or result.
      */
-    getVideosOperation(parameters: types.OperationGetParameters): Promise<types.GenerateVideosOperation>;
+    getVideosOperation(parameters: types.OperationGetParameters<types.GenerateVideosResponse, types.GenerateVideosOperation>): Promise<types.GenerateVideosOperation>;
+    /**
+     * Gets the status of a long-running operation.
+     *
+     * @param parameters The parameters for the get operation request.
+     * @return The updated Operation object, with the latest status or result.
+     */
+    get<T, U extends types.Operation<T>>(parameters: types.OperationGetParameters<T, U>): Promise<types.Operation<T>>;
     private getVideosOperationInternal;
     private fetchPredictVideosOperationInternal;
 }
@@ -5129,14 +5204,6 @@ export declare enum Outcome {
     OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
 }
 
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * Pagers for the GenAI List APIs.
- */
 export declare enum PagedItem {
     PAGED_ITEM_BATCH_JOBS = "batchJobs",
     PAGED_ITEM_MODELS = "models",
@@ -5154,6 +5221,7 @@ declare interface PagedItemConfig {
 
 declare interface PagedItemResponse<T> {
     nextPageToken?: string;
+    sdkHttpResponse?: types.HttpResponse;
     batchJobs?: T[];
     models?: T[];
     tuningJobs?: T[];
@@ -5169,6 +5237,7 @@ export declare class Pager<T> implements AsyncIterable<T> {
     private pageInternal;
     private paramsInternal;
     private pageInternalSize;
+    private sdkHttpResponseInternal?;
     protected requestInternal: (params: PagedItemConfig) => Promise<PagedItemResponse<T>>;
     protected idxInternal: number;
     constructor(name: PagedItem, request: (params: PagedItemConfig) => Promise<PagedItemResponse<T>>, response: PagedItemResponse<T>, params: PagedItemConfig);
@@ -5193,6 +5262,10 @@ export declare class Pager<T> implements AsyncIterable<T> {
      * The number of items in the page is less than or equal to the page length.
      */
     get pageSize(): number;
+    /**
+     * Returns the headers of the API response.
+     */
+    get sdkHttpResponse(): types.HttpResponse | undefined;
     /**
      * Returns the parameters when making the API request for the next page.
      *
@@ -6386,6 +6459,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);
@@ -6674,7 +6759,6 @@ declare namespace types {
         GenerateVideosParameters,
         GeneratedVideo,
         GenerateVideosResponse,
-        GenerateVideosOperation,
         GetTuningJobConfig,
         GetTuningJobParameters,
         TunedModelCheckpoint,
@@ -6703,7 +6787,7 @@ declare namespace types {
         TuningValidationDataset,
         CreateTuningJobConfig,
         CreateTuningJobParameters,
-        Operation,
+        TuningOperation,
         CreateCachedContentConfig,
         CreateCachedContentParameters,
         CachedContentUsageMetadata,
@@ -6778,6 +6862,10 @@ declare namespace types {
         LiveServerGoAway,
         LiveServerSessionResumptionUpdate,
         LiveServerMessage,
+        OperationGetParameters,
+        OperationFromAPIResponseParameters,
+        Operation,
+        GenerateVideosOperation,
         AutomaticActivityDetection,
         RealtimeInputConfig,
         SessionResumptionConfig,
@@ -6821,7 +6909,6 @@ declare namespace types {
         LiveConnectConstraints,
         CreateAuthTokenConfig,
         CreateAuthTokenParameters,
-        OperationGetParameters,
         BlobImageUnion,
         PartUnion,
         PartListUnion,
@@ -6832,7 +6919,8 @@ declare namespace types {
         ToolUnion,
         ToolListUnion,
         DownloadableFileUnion,
-        BatchJobSourceUnion
+        BatchJobSourceUnion,
+        BatchJobDestinationUnion
     }
 }