@google/genai 1.15.0 → 1.17.0

package/dist/genai.d.ts

@@ -817,6 +817,27 @@ export declare interface CancelBatchJobParameters {
     config?: CancelBatchJobConfig;
 }
 
+/** Optional parameters for tunings.cancel method. */
+export declare interface CancelTuningJobConfig {
+    /** Used to override HTTP request options. */
+    httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
+}
+
+/** Parameters for the cancel method. */
+export declare interface CancelTuningJobParameters {
+    /** The resource name of the tuning job. */
+    name: string;
+    /** Optional parameters for the request. */
+    config?: CancelTuningJobConfig;
+}
+
 /** A response candidate generated from the model. */
 export declare interface Candidate {
     /** Contains the multi-part content of the response.
@@ -1561,6 +1582,8 @@ export declare interface DeleteCachedContentParameters {
 
 /** Empty response for caches.delete method. */
 export declare class DeleteCachedContentResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
 }
 
 /** Used to override the default configuration. */
@@ -1586,6 +1609,8 @@ export declare interface DeleteFileParameters {
 
 /** Response for the delete file method. */
 export declare class DeleteFileResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
 }
 
 /** Configuration for deleting a tuned model. */
@@ -1609,6 +1634,8 @@ export declare interface DeleteModelParameters {
 }
 
 export declare class DeleteModelResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
 }
 
 /** The return value of delete operation. */
@@ -1693,54 +1720,40 @@ export declare interface EditImageConfig {
      be charged usage for any applicable operations.
      */
     abortSignal?: AbortSignal;
-    /** Cloud Storage URI used to store the generated images.
-     */
+    /** Cloud Storage URI used to store the generated images. */
     outputGcsUri?: string;
-    /** Description of what to discourage in the generated images.
-     */
+    /** Description of what to discourage in the generated images. */
     negativePrompt?: string;
-    /** Number of images to generate.
-     */
+    /** Number of images to generate. */
     numberOfImages?: number;
     /** Aspect ratio of the generated images. Supported values are
-     "1:1", "3:4", "4:3", "9:16", and "16:9".
-     */
+     "1:1", "3:4", "4:3", "9:16", and "16:9". */
     aspectRatio?: string;
     /** Controls how much the model adheres to the text prompt. Large
      values increase output and prompt alignment, but may compromise image
-     quality.
-     */
+     quality. */
     guidanceScale?: number;
     /** Random seed for image generation. This is not available when
-     ``add_watermark`` is set to true.
-     */
+     ``add_watermark`` is set to true. */
     seed?: number;
-    /** Filter level for safety filtering.
-     */
+    /** Filter level for safety filtering. */
     safetyFilterLevel?: SafetyFilterLevel;
-    /** Allows generation of people by the model.
-     */
+    /** Allows generation of people by the model. */
     personGeneration?: PersonGeneration;
     /** Whether to report the safety scores of each generated image and
-     the positive prompt in the response.
-     */
+     the positive prompt in the response. */
     includeSafetyAttributes?: boolean;
     /** Whether to include the Responsible AI filter reason if the image
-     is filtered out of the response.
-     */
+     is filtered out of the response. */
     includeRaiReason?: boolean;
-    /** Language of the text in the prompt.
-     */
+    /** Language of the text in the prompt. */
     language?: ImagePromptLanguage;
-    /** MIME type of the generated image.
-     */
+    /** MIME type of the generated image. */
     outputMimeType?: string;
     /** Compression quality of the generated image (for ``image/jpeg``
-     only).
-     */
+     only). */
     outputCompressionQuality?: number;
-    /** Whether to add a watermark to the generated images.
-     */
+    /** Whether to add a watermark to the generated images. */
     addWatermark?: boolean;
     /** Describes the editing mode for the request. */
     editMode?: EditMode;
@@ -1769,7 +1782,7 @@ export declare class EditImageResponse {
     generatedImages?: GeneratedImage[];
 }
 
-/** Enum representing the Imagen 3 Edit mode. */
+/** Enum representing the editing mode. */
 export declare enum EditMode {
     EDIT_MODE_DEFAULT = "EDIT_MODE_DEFAULT",
     EDIT_MODE_INPAINT_REMOVAL = "EDIT_MODE_INPAINT_REMOVAL",
@@ -2268,7 +2281,11 @@ export declare enum FunctionCallingConfigMode {
     /**
      * Model will not predict any function calls. Model behavior is same as when not passing any function declarations.
      */
-    NONE = "NONE"
+    NONE = "NONE",
+    /**
+     * Model decides to predict either a function call or a natural language response, but will validate function calls with constrained decoding. If "allowed_function_names" are set, the predicted function call will be limited to any one of "allowed_function_names", else the predicted function call will be any one of the provided "function_declarations".
+     */
+    VALIDATED = "VALIDATED"
 }
 
 /** Defines a function that the model can generate JSON inputs for.
@@ -2693,20 +2710,16 @@ export declare class GenerateContentResponseUsageMetadata {
 
 /** An output image. */
 export declare interface GeneratedImage {
-    /** The output image data.
-     */
+    /** The output image data. */
     image?: Image_2;
     /** Responsible AI filter reason if the image is filtered out of the
-     response.
-     */
+     response. */
     raiFilteredReason?: string;
     /** Safety attributes of the image. Lists of RAI categories and their
-     scores of each content.
-     */
+     scores of each content. */
     safetyAttributes?: SafetyAttributes;
     /** The rewritten prompt used for the image generation if the prompt
-     enhancer is enabled.
-     */
+     enhancer is enabled. */
     enhancedPrompt?: string;
 }
 
@@ -2735,61 +2748,45 @@ export declare interface GenerateImagesConfig {
      be charged usage for any applicable operations.
      */
     abortSignal?: AbortSignal;
-    /** Cloud Storage URI used to store the generated images.
-     */
+    /** Cloud Storage URI used to store the generated images. */
     outputGcsUri?: string;
-    /** Description of what to discourage in the generated images.
-     */
+    /** Description of what to discourage in the generated images. */
     negativePrompt?: string;
-    /** Number of images to generate.
-     */
+    /** Number of images to generate. */
     numberOfImages?: number;
     /** Aspect ratio of the generated images. Supported values are
-     "1:1", "3:4", "4:3", "9:16", and "16:9".
-     */
+     "1:1", "3:4", "4:3", "9:16", and "16:9". */
     aspectRatio?: string;
     /** Controls how much the model adheres to the text prompt. Large
      values increase output and prompt alignment, but may compromise image
-     quality.
-     */
+     quality. */
     guidanceScale?: number;
     /** Random seed for image generation. This is not available when
-     ``add_watermark`` is set to true.
-     */
+     ``add_watermark`` is set to true. */
     seed?: number;
-    /** Filter level for safety filtering.
-     */
+    /** Filter level for safety filtering. */
     safetyFilterLevel?: SafetyFilterLevel;
-    /** Allows generation of people by the model.
-     */
+    /** Allows generation of people by the model. */
     personGeneration?: PersonGeneration;
     /** Whether to report the safety scores of each generated image and
-     the positive prompt in the response.
-     */
+     the positive prompt in the response. */
     includeSafetyAttributes?: boolean;
     /** Whether to include the Responsible AI filter reason if the image
-     is filtered out of the response.
-     */
+     is filtered out of the response. */
     includeRaiReason?: boolean;
-    /** Language of the text in the prompt.
-     */
+    /** Language of the text in the prompt. */
     language?: ImagePromptLanguage;
-    /** MIME type of the generated image.
-     */
+    /** MIME type of the generated image. */
     outputMimeType?: string;
     /** Compression quality of the generated image (for ``image/jpeg``
-     only).
-     */
+     only). */
     outputCompressionQuality?: number;
-    /** Whether to add a watermark to the generated images.
-     */
+    /** 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).
-     */
+     Supported sizes are 1K and 2K (not supported for Imagen 3 models). */
     imageSize?: string;
-    /** Whether to use the prompt rewriting logic.
-     */
+    /** Whether to use the prompt rewriting logic. */
     enhancePrompt?: boolean;
 }
 
@@ -2810,12 +2807,10 @@ export declare interface GenerateImagesParameters {
 export declare class GenerateImagesResponse {
     /** Used to retain the full HTTP response. */
     sdkHttpResponse?: HttpResponse;
-    /** List of generated images.
-     */
+    /** List of generated images. */
     generatedImages?: GeneratedImage[];
     /** Safety attributes of the positive prompt. Only populated if
-     ``include_safety_attributes`` is set to True.
-     */
+     ``include_safety_attributes`` is set to True. */
     positivePromptSafetyAttributes?: SafetyAttributes;
 }
 
@@ -2838,23 +2833,32 @@ export declare interface GenerateVideosConfig {
     fps?: number;
     /** Duration of the clip for video generation in seconds. */
     durationSeconds?: number;
-    /** The RNG seed. If RNG seed is exactly same for each request with unchanged inputs, the prediction results will be consistent. Otherwise, a random RNG seed will be used each time to produce a different result. */
+    /** The RNG seed. If RNG seed is exactly same for each request with
+     unchanged inputs, the prediction results will be consistent. Otherwise,
+     a random RNG seed will be used each time to produce a different
+     result. */
     seed?: number;
-    /** The aspect ratio for the generated video. 16:9 (landscape) and 9:16 (portrait) are supported. */
+    /** The aspect ratio for the generated video. 16:9 (landscape) and
+     9:16 (portrait) are supported. */
     aspectRatio?: string;
-    /** The resolution for the generated video. 720p and 1080p 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. */
+    /** Whether allow to generate person videos, and restrict to specific
+     ages. Supported values are: dont_allow, allow_adult. */
     personGeneration?: string;
-    /** The pubsub topic where to publish the video generation progress. */
+    /** The pubsub topic where to publish the video generation
+     progress. */
     pubsubTopic?: string;
-    /** Optional field in addition to the text content. Negative prompts can be explicitly stated here to help generate the video. */
+    /** Explicitly state what should not be included in the generated
+     videos. */
     negativePrompt?: string;
     /** Whether to use the prompt rewriting logic. */
     enhancePrompt?: boolean;
     /** Whether to generate audio along with the video. */
     generateAudio?: boolean;
-    /** Image to use as the last frame of generated videos. Only supported for image to video use cases. */
+    /** Image to use as the last frame of generated videos.
+     Only supported for image to video use cases. */
     lastFrame?: Image_2;
     /** The images to use as the references to generate the videos.
      If this field is provided, the text prompt field must also be provided.
@@ -2866,7 +2870,7 @@ export declare interface GenerateVideosConfig {
     compressionQuality?: VideoCompressionQuality;
 }
 
-/** A video generation long-running operation. */
+/** A video generation 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;
@@ -2876,7 +2880,7 @@ export declare class GenerateVideosOperation implements Operation<GenerateVideos
     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. */
+    /** The generated videos. */
     response?: GenerateVideosResponse;
     /** The full HTTP response. */
     sdkHttpResponse?: HttpResponse;
@@ -2892,14 +2896,17 @@ export declare interface GenerateVideosParameters {
     /** ID of the model to use. For a list of models, see `Google models
      <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_. */
     model: string;
-    /** The text prompt for generating the videos. Optional for image to video use cases. */
+    /** The text prompt for generating the videos.
+     Optional if image or video is provided. */
     prompt?: string;
     /** The input image for generating the videos.
-     Optional if prompt or video is provided. */
+     Optional if prompt is provided. Not allowed if video is provided. */
     image?: Image_2;
     /** The input video for video extension use cases.
-     Optional if prompt or image is provided. */
+     Optional if prompt is provided. Not allowed if image is provided. */
     video?: Video;
+    /** A set of source input(s) for video generation. */
+    source?: GenerateVideosSource;
     /** Configuration for generating videos. */
     config?: GenerateVideosConfig;
 }
@@ -2914,6 +2921,19 @@ export declare class GenerateVideosResponse {
     raiMediaFilteredReasons?: string[];
 }
 
+/** A set of source input(s) for video generation. */
+export declare interface GenerateVideosSource {
+    /** The text prompt for generating the videos.
+     Optional if image or video is provided. */
+    prompt?: string;
+    /** The input image for generating the videos.
+     Optional if prompt is provided. Not allowed if video is provided. */
+    image?: Image_2;
+    /** The input video for video extension use cases.
+     Optional if prompt is provided. Not allowed if image is provided. */
+    video?: Video;
+}
+
 /** Generation config. */
 export declare interface GenerationConfig {
     /** Optional. Config for model selection. */
@@ -3097,7 +3117,6 @@ export declare interface GetOperationParameters {
     config?: GetOperationConfig;
 }
 
-/** Optional parameters for tunings.get method. */
 export declare interface GetTuningJobConfig {
     /** Used to override HTTP request options. */
     httpOptions?: HttpOptions;
@@ -3596,12 +3615,10 @@ export declare class HttpResponse {
 /** An image. */
 declare interface Image_2 {
     /** The Cloud Storage URI of the image. ``Image`` can contain a value
-     for this field or the ``image_bytes`` field but not both.
-     */
+     for this field or the ``image_bytes`` field but not both. */
     gcsUri?: string;
     /** The image bytes data. ``Image`` can contain a value for this field
      or the ``gcs_uri`` field but not both.
-
      * @remarks Encoded as base64 string. */
     imageBytes?: string;
     /** The MIME type of the image. */
@@ -4652,6 +4669,7 @@ export declare interface LiveServerSessionResumptionUpdate {
     lastConsumedClientMessageIndex?: string;
 }
 
+/** Sent in response to a `LiveGenerateContentSetup` message from the client. */
 export declare interface LiveServerSetupComplete {
     /** The session id of the live session. */
     sessionId?: string;
@@ -5050,7 +5068,9 @@ export declare class Models extends BaseModule {
      * ```ts
      * const operation = await ai.models.generateVideos({
      *  model: 'veo-2.0-generate-001',
-     *  prompt: 'A neon hologram of a cat driving at top speed',
+     *  source: {
+     *    prompt: 'A neon hologram of a cat driving at top speed',
+     *  },
      *  config: {
      *    numberOfVideos: 1
      * });
@@ -5089,26 +5109,16 @@ export declare class Models extends BaseModule {
      */
     embedContent(params: types.EmbedContentParameters): Promise<types.EmbedContentResponse>;
     /**
-     * Generates an image based on a text description and configuration.
-     *
-     * @param params - The parameters for generating images.
-     * @return The response from the API.
-     *
-     * @example
-     * ```ts
-     * const response = await ai.models.generateImages({
-     *  model: 'imagen-3.0-generate-002',
-     *  prompt: 'Robot holding a red skateboard',
-     *  config: {
-     *    numberOfImages: 1,
-     *    includeRaiReason: true,
-     *  },
-     * });
-     * console.log(response?.generatedImages?.[0]?.image?.imageBytes);
-     * ```
+     * Private method for generating images.
      */
     private generateImagesInternal;
+    /**
+     * Private method for editing an image.
+     */
     private editImageInternal;
+    /**
+     * Private method for upscaling an image.
+     */
     private upscaleImageInternal;
     /**
      * Recontextualizes an image.
@@ -5247,27 +5257,7 @@ export declare class Models extends BaseModule {
      */
     computeTokens(params: types.ComputeTokensParameters): Promise<types.ComputeTokensResponse>;
     /**
-     *  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);
-     * ```
+     * Private method for generating videos.
      */
     private generateVideosInternal;
 }
@@ -5336,10 +5326,10 @@ export declare interface OperationFromAPIResponseParameters {
 
 /** Parameters for the get method of the operations module. */
 export declare interface OperationGetParameters<T, U extends Operation<T>> {
-    /** The operation to be retrieved. */
-    operation: U;
     /** Used to override the default configuration. */
     config?: GetOperationConfig;
+    /** The operation to be retrieved. */
+    operation: U;
 }
 
 export declare class Operations extends BaseModule {
@@ -5738,6 +5728,8 @@ export declare interface RecontextImageConfig {
     /** Whether allow to generate person images, and restrict to specific
      ages. */
     personGeneration?: PersonGeneration;
+    /** Whether to add a SynthID watermark to the generated images. */
+    addWatermark?: boolean;
     /** MIME type of the generated image. */
     outputMimeType?: string;
     /** Compression quality of the generated image (for ``image/jpeg``
@@ -5853,14 +5845,11 @@ export declare interface RetrievalMetadata {
 
 /** Safety attributes of a GeneratedImage or the user-provided prompt. */
 export declare interface SafetyAttributes {
-    /** List of RAI categories.
-     */
+    /** List of RAI categories. */
     categories?: string[];
-    /** List of scores of each categories.
-     */
+    /** List of scores of each categories. */
     scores?: number[];
-    /** Internal use only.
-     */
+    /** Internal use only. */
     contentType?: string;
 }
 
@@ -6622,7 +6611,7 @@ export declare class Tokens extends BaseModule {
 
 /** Tokens info with a list of tokens and the corresponding list of token ids. */
 export declare interface TokensInfo {
-    /** Optional. Optional fields for the role from the corresponding Content. */
+    /** Optional fields for the role from the corresponding Content. */
     role?: string;
     /** A list of token ids from the input. */
     tokenIds?: string[];
@@ -6889,6 +6878,18 @@ declare class Tunings extends BaseModule {
     tune: (params: types.CreateTuningJobParameters) => Promise<types.TuningJob>;
     private getInternal;
     private listInternal;
+    /**
+     * Cancels a tuning job.
+     *
+     * @param params - The parameters for the cancel request.
+     * @return The empty response returned by the API.
+     *
+     * @example
+     * ```ts
+     * await ai.tunings.cancel({name: '...'}); // The server-generated resource name.
+     * ```
+     */
+    cancel(params: types.CancelTuningJobParameters): Promise<void>;
     private tuneInternal;
     private tuneMldevInternal;
 }
@@ -6996,6 +6997,7 @@ declare namespace types {
         SubjectReferenceType,
         EditMode,
         SegmentMode,
+        VideoGenerationReferenceType,
         VideoCompressionQuality,
         FileState,
         FileSource,
@@ -7157,11 +7159,14 @@ declare namespace types {
         TokensInfo,
         ComputeTokensResponse,
         Video,
+        GenerateVideosSource,
         VideoGenerationReferenceImage,
         GenerateVideosConfig,
         GenerateVideosParameters,
         GeneratedVideo,
         GenerateVideosResponse,
+        Operation,
+        GenerateVideosOperation,
         GetTuningJobConfig,
         GetTuningJobParameters,
         TunedModelCheckpoint,
@@ -7187,6 +7192,8 @@ declare namespace types {
         ListTuningJobsConfig,
         ListTuningJobsParameters,
         ListTuningJobsResponse,
+        CancelTuningJobConfig,
+        CancelTuningJobParameters,
         TuningExample,
         TuningDataset,
         TuningValidationDataset,
@@ -7267,10 +7274,7 @@ declare namespace types {
         LiveServerGoAway,
         LiveServerSessionResumptionUpdate,
         LiveServerMessage,
-        OperationGetParameters,
         OperationFromAPIResponseParameters,
-        Operation,
-        GenerateVideosOperation,
         AutomaticActivityDetection,
         RealtimeInputConfig,
         SessionResumptionConfig,
@@ -7314,6 +7318,7 @@ declare namespace types {
         LiveConnectConstraints,
         CreateAuthTokenConfig,
         CreateAuthTokenParameters,
+        OperationGetParameters,
         CreateTuningJobParameters,
         BlobImageUnion,
         PartUnion,
@@ -7444,13 +7449,15 @@ export declare interface UpscaleImageConfig {
      be charged usage for any applicable operations.
      */
     abortSignal?: AbortSignal;
+    /** Cloud Storage URI used to store the generated images. */
+    outputGcsUri?: string;
     /** Whether to include a reason for filtered-out images in the
      response. */
     includeRaiReason?: boolean;
     /** The image format that the output should be saved as. */
     outputMimeType?: string;
-    /** The level of compression if the ``output_mime_type`` is
-     ``image/jpeg``. */
+    /** The level of compression. Only applicable if the
+     ``output_mime_type`` is ``image/jpeg``. */
     outputCompressionQuality?: number;
     /** Whether to add an image enhancing step before upscaling.
      It is expected to suppress the noise and JPEG compression artifacts
@@ -7604,7 +7611,7 @@ export declare interface Video {
     /** Video bytes.
      * @remarks Encoded as base64 string. */
     videoBytes?: string;
-    /** Video encoding, for example "video/mp4". */
+    /** Video encoding, for example ``video/mp4``. */
     mimeType?: string;
 }
 
@@ -7624,13 +7631,26 @@ export declare enum VideoCompressionQuality {
 
 /** A reference image for video generation. */
 export declare interface VideoGenerationReferenceImage {
-    /** The reference image.
-     */
+    /** The reference image. */
     image?: Image_2;
     /** The type of the reference image, which defines how the reference
-     image will be used to generate the video. Supported values are 'asset'
-     or 'style'. */
-    referenceType?: string;
+     image will be used to generate the video. */
+    referenceType?: VideoGenerationReferenceType;
+}
+
+/** Enum for the reference type of a video generation reference image. */
+export declare enum VideoGenerationReferenceType {
+    /**
+     * A reference image that provides assets to the generated video,
+     such as the scene, an object, a character, etc.
+     */
+    ASSET = "ASSET",
+    /**
+     * A reference image that provides aesthetics including colors,
+     lighting, texture, etc., to be used as the style of the generated video,
+     such as 'anime', 'photography', 'origami', etc.
+     */
+    STYLE = "STYLE"
 }
 
 /** Describes how the video in the Part should be used by the model. */