@google/genai 1.17.0 → 1.19.0

package/dist/web/web.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. */
@@ -1454,6 +1517,8 @@ export declare interface CreateTuningJobConfig {
     batchSize?: number;
     /** The learning rate hyperparameter for tuning. If not set, a default of 0.001 or 0.0002 will be calculated based on the number of training examples. */
     learningRate?: number;
+    /** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
+    labels?: Record<string, string>;
 }
 
 /** Supervised fine-tuning job creation parameters - optional fields. */
@@ -1794,6 +1859,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. */
@@ -1862,6 +1937,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. */
@@ -2866,6 +2951,8 @@ export declare interface GenerateVideosConfig {
      be associated with a type. Veo 2 supports up to 3 asset images *or* 1
      style image. */
     referenceImages?: VideoGenerationReferenceImage[];
+    /** The mask to use for generating videos. */
+    mask?: VideoGenerationMask;
     /** Compression quality of the generated videos. */
     compressionQuality?: VideoCompressionQuality;
 }
@@ -2882,13 +2969,13 @@ export declare class GenerateVideosOperation implements Operation<GenerateVideos
     error?: Record<string, unknown>;
     /** The generated videos. */
     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>;
+    /** The full HTTP response. */
+    sdkHttpResponse?: HttpResponse;
 }
 
 /** Class that represents the parameters for generating videos. */
@@ -3667,6 +3754,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
@@ -5521,12 +5618,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). */
@@ -6284,6 +6383,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
@@ -7018,9 +7127,9 @@ declare namespace types {
         VideoMetadata,
         Blob_2 as Blob,
         FileData,
+        FunctionCall,
         CodeExecutionResult,
         ExecutableCode,
-        FunctionCall,
         FunctionResponse,
         Part,
         Content,
@@ -7166,6 +7275,7 @@ declare namespace types {
         Video,
         GenerateVideosSource,
         VideoGenerationReferenceImage,
+        VideoGenerationMask,
         GenerateVideosConfig,
         GenerateVideosParameters,
         GeneratedVideo,
@@ -7236,10 +7346,16 @@ declare namespace types {
         BatchJobSource,
         JobError,
         InlinedResponse,
+        SingleEmbedContentResponse,
+        InlinedEmbedContentResponse,
         BatchJobDestination,
         CreateBatchJobConfig,
         CreateBatchJobParameters,
         BatchJob,
+        EmbedContentBatch,
+        EmbeddingsBatchJobSource,
+        CreateEmbeddingsBatchJobConfig,
+        CreateEmbeddingsBatchJobParameters,
         GetBatchJobConfig,
         GetBatchJobParameters,
         CancelBatchJobConfig,
@@ -7634,6 +7750,16 @@ export declare enum VideoCompressionQuality {
     LOSSLESS = "LOSSLESS"
 }
 
+/** A mask for video generation. */
+export declare interface VideoGenerationMask {
+    /** The image mask to use for generating videos. */
+    image?: Image_2;
+    /** Describes how the mask will be used. Inpainting masks must
+     match the aspect ratio of the input video. Outpainting masks can be
+     either 9:16 or 16:9. */
+    maskMode?: string;
+}
+
 /** A reference image for video generation. */
 export declare interface VideoGenerationReferenceImage {
     /** The reference image. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google/genai",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "",
   "type": "module",
   "main": "dist/node/index.mjs",