@google/genai 1.17.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. */
@@ -1794,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. */
@@ -1862,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. */
@@ -3662,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
@@ -5516,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). */
@@ -6279,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
@@ -7013,9 +7118,9 @@ declare namespace types {
         VideoMetadata,
         Blob_2 as Blob,
         FileData,
+        FunctionCall,
         CodeExecutionResult,
         ExecutableCode,
-        FunctionCall,
         FunctionResponse,
         Part,
         Content,
@@ -7231,10 +7336,16 @@ declare namespace types {
         BatchJobSource,
         JobError,
         InlinedResponse,
+        SingleEmbedContentResponse,
+        InlinedEmbedContentResponse,
         BatchJobDestination,
         CreateBatchJobConfig,
         CreateBatchJobParameters,
         BatchJob,
+        EmbedContentBatch,
+        EmbeddingsBatchJobSource,
+        CreateEmbeddingsBatchJobConfig,
+        CreateEmbeddingsBatchJobParameters,
         GetBatchJobConfig,
         GetBatchJobParameters,
         CancelBatchJobConfig,