@google/genai 1.16.0 → 1.18.0

package/dist/genai.d.ts

@@ -437,6 +437,22 @@ export declare class Batches extends BaseModule {
      * ```
      */
     create: (params: types.CreateBatchJobParameters) => Promise<types.BatchJob>;
+    /**
+     * **Experimental** Creates an embedding batch job.
+     *
+     * @param params - The parameters for create embedding batch job request.
+     * @return The created batch job.
+     *
+     * @example
+     * ```ts
+     * const response = await ai.batches.createEmbeddings({
+     *   model: 'text-embedding-004',
+     *   src: {fileName: 'files/my_embedding_input'},
+     * });
+     * console.log(response);
+     * ```
+     */
+    createEmbeddings: (params: types.CreateEmbeddingsBatchJobParameters) => Promise<types.BatchJob>;
     /**
      * Lists batch job configurations.
      *
@@ -452,6 +468,11 @@ export declare class Batches extends BaseModule {
      * ```
      */
     list: (params?: types.ListBatchJobsParameters) => Promise<Pager<types.BatchJob>>;
+    private createInlinedGenerateContentRequest;
+    private createInlinedEmbedContentRequest;
+    private getGcsUri;
+    private getBigqueryUri;
+    private formatDestination;
     /**
      * Internal method to create batch job.
      *
@@ -460,6 +481,14 @@ export declare class Batches extends BaseModule {
      *
      */
     private createInternal;
+    /**
+     * Internal method to create batch job.
+     *
+     * @param params - The parameters for create batch job request.
+     * @return The created batch job.
+     *
+     */
+    private createEmbeddingsInternal;
     /**
      * Gets batch job configurations.
      *
@@ -558,6 +587,11 @@ export declare interface BatchJobDestination {
      the input requests.
      */
     inlinedResponses?: InlinedResponse[];
+    /** The responses to the requests in the batch. Returned when the batch was
+     built using inlined requests. The responses will be in the same order as
+     the input requests.
+     */
+    inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
 }
 
 export declare type BatchJobDestinationUnion = BatchJobDestination | string;
@@ -1351,6 +1385,35 @@ export declare interface CreateChatParameters {
     history?: Content[];
 }
 
+/** Config for optional parameters. */
+export declare interface CreateEmbeddingsBatchJobConfig {
+    /** 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;
+    /** The user-defined name of this BatchJob.
+     */
+    displayName?: string;
+}
+
+/** Config for batches.create parameters. */
+export declare interface CreateEmbeddingsBatchJobParameters {
+    /** The name of the model to produces the predictions via the BatchJob.
+     */
+    model?: string;
+    /** input data to run batch job".
+     */
+    src: EmbeddingsBatchJobSource;
+    /** Optional parameters for creating a BatchJob.
+     */
+    config?: CreateEmbeddingsBatchJobConfig;
+}
+
 /** Used to override the default configuration. */
 export declare interface CreateFileConfig {
     /** Used to override HTTP request options. */
@@ -1720,54 +1783,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;
@@ -1796,7 +1845,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",
@@ -1808,6 +1857,16 @@ export declare enum EditMode {
     EDIT_MODE_PRODUCT_IMAGE = "EDIT_MODE_PRODUCT_IMAGE"
 }
 
+/** Parameters for the embed_content method. */
+export declare interface EmbedContentBatch {
+    /** The content to embed. Only the `parts.text` fields will be counted.
+     */
+    contents?: ContentListUnion;
+    /** Configuration that contains optional parameters.
+     */
+    config?: EmbedContentConfig;
+}
+
 /** Optional parameters for the embed_content method. */
 export declare interface EmbedContentConfig {
     /** Used to override HTTP request options. */
@@ -1876,6 +1935,16 @@ export declare class EmbedContentResponse {
     metadata?: EmbedContentMetadata;
 }
 
+export declare interface EmbeddingsBatchJobSource {
+    /** The Gemini Developer API's file resource name of the input data
+     (e.g. "files/12345").
+     */
+    fileName?: string;
+    /** The Gemini Developer API's inlined input data to run batch job.
+     */
+    inlinedRequests?: EmbedContentBatch;
+}
+
 /** Represents a customer-managed encryption key spec that can be applied to a top-level resource. */
 export declare interface EncryptionSpec {
     /** Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. */
@@ -2724,20 +2793,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;
 }
 
@@ -2766,61 +2831,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;
 }
 
@@ -2841,12 +2890,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;
 }
 
@@ -2869,23 +2916,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.
@@ -2923,13 +2979,14 @@ 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;
@@ -2953,10 +3010,10 @@ export declare interface GenerateVideosSource {
      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;
 }
 
@@ -3641,12 +3698,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. */
@@ -3690,6 +3745,16 @@ export declare enum ImagePromptLanguage {
     es = "es"
 }
 
+/** Config for `inlined_embedding_responses` parameter. */
+export declare class InlinedEmbedContentResponse {
+    /** The response to the request.
+     */
+    response?: SingleEmbedContentResponse;
+    /** The error encountered while processing the request.
+     */
+    error?: JobError;
+}
+
 /** Config for inlined request. */
 export declare interface InlinedRequest {
     /** ID of the model to use. For a list of models, see `Google models
@@ -5137,26 +5202,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.
@@ -5295,27 +5350,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;
 }
@@ -5574,12 +5609,14 @@ export declare interface Part {
     /** An opaque signature for the thought so it can be reused in subsequent requests.
      * @remarks Encoded as base64 string. */
     thoughtSignature?: string;
+    /** A predicted [FunctionCall] returned from the model that contains a string
+     representing the [FunctionDeclaration.name] and a structured JSON object
+     containing the parameters and their values. */
+    functionCall?: FunctionCall;
     /** Optional. Result of executing the [ExecutableCode]. */
     codeExecutionResult?: CodeExecutionResult;
     /** Optional. Code generated by the model that is meant to be executed. */
     executableCode?: ExecutableCode;
-    /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
-    functionCall?: FunctionCall;
     /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
     functionResponse?: FunctionResponse;
     /** Optional. Text part (can be code). */
@@ -5903,14 +5940,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;
 }
 
@@ -6340,6 +6374,16 @@ export declare interface SessionResumptionConfig {
  */
 export declare function setDefaultBaseUrls(baseUrlParams: BaseUrlParameters): void;
 
+/** Config for `response` parameter. */
+export declare class SingleEmbedContentResponse {
+    /** The response to the request.
+     */
+    embedding?: ContentEmbedding;
+    /** The error encountered while processing the request.
+     */
+    tokenCount?: string;
+}
+
 /** Context window will be truncated by keeping only suffix of it.
 
  Context window will always be cut at start of USER role turn. System
@@ -7074,9 +7118,9 @@ declare namespace types {
         VideoMetadata,
         Blob_2 as Blob,
         FileData,
+        FunctionCall,
         CodeExecutionResult,
         ExecutableCode,
-        FunctionCall,
         FunctionResponse,
         Part,
         Content,
@@ -7292,10 +7336,16 @@ declare namespace types {
         BatchJobSource,
         JobError,
         InlinedResponse,
+        SingleEmbedContentResponse,
+        InlinedEmbedContentResponse,
         BatchJobDestination,
         CreateBatchJobConfig,
         CreateBatchJobParameters,
         BatchJob,
+        EmbedContentBatch,
+        EmbeddingsBatchJobSource,
+        CreateEmbeddingsBatchJobConfig,
+        CreateEmbeddingsBatchJobParameters,
         GetBatchJobConfig,
         GetBatchJobParameters,
         CancelBatchJobConfig,
@@ -7517,8 +7567,8 @@ export declare interface UpscaleImageConfig {
     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
@@ -7672,7 +7722,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;
 }
 
@@ -7692,8 +7742,7 @@ 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. */