@google/genai 1.11.0 → 1.13.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). */
@@ -1595,6 +1599,8 @@ export declare class DeleteModelResponse {
 
 /** The return value of delete operation. */
 export declare interface DeleteResourceJob {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     name?: string;
     done?: boolean;
     error?: JobError;
@@ -1771,6 +1777,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 +1852,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.
      */
@@ -2493,9 +2503,6 @@ export declare class GenerateContentResponse {
     /** Timestamp when the request is made to the server.
      */
     createTime?: string;
-    /** Identifier for each response.
-     */
-    responseId?: string;
     /** The history of automatic function calling.
      */
     automaticFunctionCallingHistory?: Content[];
@@ -2503,6 +2510,8 @@ export declare class GenerateContentResponse {
     modelVersion?: string;
     /** Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */
     promptFeedback?: GenerateContentResponsePromptFeedback;
+    /** Output only. response_id is used to identify each response. It is the encoding of the event_id. */
+    responseId?: string;
     /** Usage metadata about the response(s). */
     usageMetadata?: GenerateContentResponseUsageMetadata;
     /**
@@ -2779,6 +2788,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[];
@@ -2841,6 +2852,8 @@ export declare class GenerateVideosOperation implements Operation<GenerateVideos
     error?: Record<string, unknown>;
     /** 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
@@ -4271,6 +4284,8 @@ export declare interface LiveMusicGenerationConfig {
     muteDrums?: boolean;
     /** Whether the audio output should contain only bass and drums. */
     onlyBassAndDrums?: boolean;
+    /** The mode of music generation. Default mode is QUALITY. */
+    musicGenerationMode?: MusicGenerationMode;
 }
 
 /** The playback control signal to apply to the music generation. */
@@ -5014,6 +5029,45 @@ export declare class Models extends BaseModule {
     private generateImagesInternal;
     private editImageInternal;
     private upscaleImageInternal;
+    /**
+     * Recontextualizes an image.
+     *
+     * There are two types of recontextualization currently supported:
+     * 1) Imagen Product Recontext - Generate images of products in new scenes
+     *    and contexts.
+     * 2) Virtual Try-On: Generate images of persons modeling fashion products.
+     *
+     * @param params - The parameters for recontextualizing an image.
+     * @return The response from the API.
+     *
+     * @example
+     * ```ts
+     * const response1 = await ai.models.recontextImage({
+     *  model: 'imagen-product-recontext-preview-06-30',
+     *  source: {
+     *    prompt: 'In a modern kitchen setting.',
+     *    productImages: [productImage],
+     *  },
+     *  config: {
+     *    numberOfImages: 1,
+     *  },
+     * });
+     * console.log(response1?.generatedImages?.[0]?.image?.imageBytes);
+     *
+     * const response2 = await ai.models.recontextImage({
+     *  model: 'virtual-try-on-preview-08-04',
+     *  source: {
+     *    personImage: personImage,
+     *    productImages: [productImage],
+     *  },
+     *  config: {
+     *    numberOfImages: 1,
+     *  },
+     * });
+     * console.log(response2?.generatedImages?.[0]?.image?.imageBytes);
+     * ```
+     */
+    recontextImage(params: types.RecontextImageParameters): Promise<types.RecontextImageResponse>;
     /**
      * Fetches information about a model by name.
      *
@@ -5128,6 +5182,29 @@ export declare interface MultiSpeakerVoiceConfig {
     speakerVoiceConfigs?: SpeakerVoiceConfig[];
 }
 
+/** The mode of music generation. */
+export declare enum MusicGenerationMode {
+    /**
+     * Rely on the server default generation mode.
+     */
+    MUSIC_GENERATION_MODE_UNSPECIFIED = "MUSIC_GENERATION_MODE_UNSPECIFIED",
+    /**
+     * Steer text prompts to regions of latent space with higher quality
+     music.
+     */
+    QUALITY = "QUALITY",
+    /**
+     * Steer text prompts to regions of latent space with a larger
+     diversity of music.
+     */
+    DIVERSITY = "DIVERSITY",
+    /**
+     * Steer text prompts to regions of latent space more likely to
+     generate music with vocals.
+     */
+    VOCALIZATION = "VOCALIZATION"
+}
+
 /** 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}`. */
@@ -5403,6 +5480,12 @@ export declare interface ProactivityConfig {
     proactiveAudio?: boolean;
 }
 
+/** An image of the product. */
+export declare interface ProductImage {
+    /** An image of the product to be recontextualized. */
+    productImage?: Image_2;
+}
+
 /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
 export declare interface RagChunk {
     /** If populated, represents where the chunk starts and ends in the document. */
@@ -5498,6 +5581,69 @@ export declare interface RealtimeInputConfig {
     turnCoverage?: TurnCoverage;
 }
 
+/** Configuration for recontextualizing an image. */
+export declare interface RecontextImageConfig {
+    /** 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;
+    /** Number of images to generate. */
+    numberOfImages?: number;
+    /** The number of sampling steps. A higher value has better image
+     quality, while a lower value has better latency. */
+    baseSteps?: number;
+    /** Cloud Storage URI used to store the generated images. */
+    outputGcsUri?: string;
+    /** Random seed for image generation. */
+    seed?: number;
+    /** Filter level for safety filtering. */
+    safetyFilterLevel?: SafetyFilterLevel;
+    /** Whether allow to generate person images, and restrict to specific
+     ages. */
+    personGeneration?: PersonGeneration;
+    /** MIME type of the generated image. */
+    outputMimeType?: string;
+    /** Compression quality of the generated image (for ``image/jpeg``
+     only). */
+    outputCompressionQuality?: number;
+    /** Whether to use the prompt rewriting logic. */
+    enhancePrompt?: boolean;
+}
+
+/** The parameters for recontextualizing an image. */
+export declare interface RecontextImageParameters {
+    /** 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;
+    /** A set of source input(s) for image recontextualization. */
+    source: RecontextImageSource;
+    /** Configuration for image recontextualization. */
+    config?: RecontextImageConfig;
+}
+
+/** The output images response. */
+export declare class RecontextImageResponse {
+    /** List of generated images. */
+    generatedImages?: GeneratedImage[];
+}
+
+/** A set of source input(s) for image recontextualization. */
+export declare interface RecontextImageSource {
+    /** A text prompt for guiding the model during image
+     recontextualization. Not supported for Virtual Try-On. */
+    prompt?: string;
+    /** Image of the person or subject who will be wearing the
+     product(s). */
+    personImage?: Image_2;
+    /** A list of product images. */
+    productImages?: ProductImage[];
+}
+
 export declare type ReferenceImage = RawReferenceImage | MaskReferenceImage | ControlReferenceImage | StyleReferenceImage | SubjectReferenceImage;
 
 /** Private class that represents a Reference image that is sent to API. */
@@ -6413,6 +6559,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. */
@@ -6461,6 +6609,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. */
@@ -6621,6 +6771,7 @@ declare namespace types {
         TurnCoverage,
         FunctionResponseScheduling,
         Scale,
+        MusicGenerationMode,
         LiveMusicPlaybackControl,
         VideoMetadata,
         Blob_2 as Blob,
@@ -6731,6 +6882,11 @@ declare namespace types {
         EditImageConfig,
         EditImageResponse,
         UpscaleImageResponse,
+        ProductImage,
+        RecontextImageSource,
+        RecontextImageConfig,
+        RecontextImageParameters,
+        RecontextImageResponse,
         GetModelConfig,
         GetModelParameters,
         Endpoint,
@@ -7070,6 +7226,8 @@ export declare interface UpscaleImageParameters {
 }
 
 export declare class UpscaleImageResponse {
+    /** Used to retain the full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
     /** Generated images. */
     generatedImages?: GeneratedImage[];
 }
@@ -7105,7 +7263,15 @@ export declare enum UrlRetrievalStatus {
     /**
      * Url retrieval is failed due to error.
      */
-    URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR"
+    URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
+    /**
+     * Url retrieval is failed because the content is behind paywall.
+     */
+    URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
+    /**
+     * Url retrieval is failed because the content is unsafe.
+     */
+    URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
 }
 
 /** Usage metadata about response(s). */