@google/genai 1.10.0 → 1.12.0

package/dist/genai.d.ts

@@ -1041,6 +1041,8 @@ export declare interface ComputeTokensParameters {
 
 /** Response for computing tokens. */
 export declare class ComputeTokensResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Lists of tokens info from the input. A ComputeTokensRequest could have multiple instances with a prompt in each instance. We also need to return lists of tokens info for the request with multiple instances. */
     tokensInfo?: TokensInfo[];
 }
@@ -1168,6 +1170,8 @@ export declare interface CountTokensParameters {
 
 /** Response for counting tokens. */
 export declare class CountTokensResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Total number of tokens. */
     totalTokens?: number;
     /** Number of tokens in the cached part of the prompt (the cached content). */
@@ -1771,6 +1775,8 @@ export declare interface EditImageParameters {
 
 /** Response for the request to edit an image. */
 export declare class EditImageResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Generated images. */
     generatedImages?: GeneratedImage[];
 }
@@ -1844,6 +1850,8 @@ export declare interface EmbedContentParameters {
 
 /** Response for the embed_content method. */
 export declare class EmbedContentResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** The embeddings for each request, in the same order as provided in
      the batch request.
      */
@@ -2755,6 +2763,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;
@@ -2775,6 +2787,8 @@ export declare interface GenerateImagesParameters {
 
 /** The output images response. */
 export declare class GenerateImagesResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** List of generated images.
      */
     generatedImages?: GeneratedImage[];
@@ -2825,8 +2839,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. */
@@ -2835,8 +2849,15 @@ 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;
+    /** The full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
+    /**
+     * 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. */
@@ -3690,6 +3711,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[];
 }
@@ -3717,6 +3740,8 @@ export declare interface ListCachedContentsParameters {
 }
 
 export declare class ListCachedContentsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     nextPageToken?: string;
     /** List of cached contents.
      */
@@ -3746,6 +3771,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. */
@@ -3774,6 +3801,8 @@ export declare interface ListModelsParameters {
 }
 
 export declare class ListModelsResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     nextPageToken?: string;
     models?: Model[];
 }
@@ -3801,6 +3830,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. */
@@ -4859,7 +4890,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;
     /**
@@ -4925,6 +4956,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;
     /**
@@ -5070,7 +5125,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. */
@@ -5085,10 +5140,37 @@ export declare interface MultiSpeakerVoiceConfig {
     speakerVoiceConfigs?: SpeakerVoiceConfig[];
 }
 
+/** A long-running 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. */
+    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>;
+    /** 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;
 }
@@ -5102,7 +5184,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;
 }
@@ -5127,14 +5216,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",
@@ -5152,6 +5233,7 @@ declare interface PagedItemConfig {
 
 declare interface PagedItemResponse<T> {
     nextPageToken?: string;
+    sdkHttpResponse?: types.HttpResponse;
     batchJobs?: T[];
     models?: T[];
     tuningJobs?: T[];
@@ -5167,6 +5249,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);
@@ -5191,6 +5274,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.
      *
@@ -6338,6 +6425,8 @@ export declare interface TuningExample {
 
 /** A tuning job. */
 export declare interface TuningJob {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
     name?: string;
     /** Output only. The detailed state of the job. */
@@ -6386,6 +6475,8 @@ export declare interface TuningJob {
 
 /** A long-running operation. */
 export declare interface TuningOperation {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** 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. */
@@ -6684,7 +6775,6 @@ declare namespace types {
         GenerateVideosParameters,
         GeneratedVideo,
         GenerateVideosResponse,
-        GenerateVideosOperation,
         GetTuningJobConfig,
         GetTuningJobParameters,
         TunedModelCheckpoint,
@@ -6788,6 +6878,10 @@ declare namespace types {
         LiveServerGoAway,
         LiveServerSessionResumptionUpdate,
         LiveServerMessage,
+        OperationGetParameters,
+        OperationFromAPIResponseParameters,
+        Operation,
+        GenerateVideosOperation,
         AutomaticActivityDetection,
         RealtimeInputConfig,
         SessionResumptionConfig,
@@ -6831,7 +6925,6 @@ declare namespace types {
         LiveConnectConstraints,
         CreateAuthTokenConfig,
         CreateAuthTokenParameters,
-        OperationGetParameters,
         BlobImageUnion,
         PartUnion,
         PartListUnion,
@@ -6993,6 +7086,8 @@ export declare interface UpscaleImageParameters {
 }
 
 export declare class UpscaleImageResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Generated images. */
     generatedImages?: GeneratedImage[];
 }