@google/genai 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/web/web.d.ts CHANGED
@@ -437,6 +437,22 @@ export declare class Batches extends BaseModule {
437
437
  * ```
438
438
  */
439
439
  create: (params: types.CreateBatchJobParameters) => Promise<types.BatchJob>;
440
+ /**
441
+ * **Experimental** Creates an embedding batch job.
442
+ *
443
+ * @param params - The parameters for create embedding batch job request.
444
+ * @return The created batch job.
445
+ *
446
+ * @example
447
+ * ```ts
448
+ * const response = await ai.batches.createEmbeddings({
449
+ * model: 'text-embedding-004',
450
+ * src: {fileName: 'files/my_embedding_input'},
451
+ * });
452
+ * console.log(response);
453
+ * ```
454
+ */
455
+ createEmbeddings: (params: types.CreateEmbeddingsBatchJobParameters) => Promise<types.BatchJob>;
440
456
  /**
441
457
  * Lists batch job configurations.
442
458
  *
@@ -452,6 +468,11 @@ export declare class Batches extends BaseModule {
452
468
  * ```
453
469
  */
454
470
  list: (params?: types.ListBatchJobsParameters) => Promise<Pager<types.BatchJob>>;
471
+ private createInlinedGenerateContentRequest;
472
+ private createInlinedEmbedContentRequest;
473
+ private getGcsUri;
474
+ private getBigqueryUri;
475
+ private formatDestination;
455
476
  /**
456
477
  * Internal method to create batch job.
457
478
  *
@@ -460,6 +481,14 @@ export declare class Batches extends BaseModule {
460
481
  *
461
482
  */
462
483
  private createInternal;
484
+ /**
485
+ * Internal method to create batch job.
486
+ *
487
+ * @param params - The parameters for create batch job request.
488
+ * @return The created batch job.
489
+ *
490
+ */
491
+ private createEmbeddingsInternal;
463
492
  /**
464
493
  * Gets batch job configurations.
465
494
  *
@@ -558,6 +587,11 @@ export declare interface BatchJobDestination {
558
587
  the input requests.
559
588
  */
560
589
  inlinedResponses?: InlinedResponse[];
590
+ /** The responses to the requests in the batch. Returned when the batch was
591
+ built using inlined requests. The responses will be in the same order as
592
+ the input requests.
593
+ */
594
+ inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
561
595
  }
562
596
 
563
597
  export declare type BatchJobDestinationUnion = BatchJobDestination | string;
@@ -1351,6 +1385,35 @@ export declare interface CreateChatParameters {
1351
1385
  history?: Content[];
1352
1386
  }
1353
1387
 
1388
+ /** Config for optional parameters. */
1389
+ export declare interface CreateEmbeddingsBatchJobConfig {
1390
+ /** Used to override HTTP request options. */
1391
+ httpOptions?: HttpOptions;
1392
+ /** Abort signal which can be used to cancel the request.
1393
+
1394
+ NOTE: AbortSignal is a client-only operation. Using it to cancel an
1395
+ operation will not cancel the request in the service. You will still
1396
+ be charged usage for any applicable operations.
1397
+ */
1398
+ abortSignal?: AbortSignal;
1399
+ /** The user-defined name of this BatchJob.
1400
+ */
1401
+ displayName?: string;
1402
+ }
1403
+
1404
+ /** Config for batches.create parameters. */
1405
+ export declare interface CreateEmbeddingsBatchJobParameters {
1406
+ /** The name of the model to produces the predictions via the BatchJob.
1407
+ */
1408
+ model?: string;
1409
+ /** input data to run batch job".
1410
+ */
1411
+ src: EmbeddingsBatchJobSource;
1412
+ /** Optional parameters for creating a BatchJob.
1413
+ */
1414
+ config?: CreateEmbeddingsBatchJobConfig;
1415
+ }
1416
+
1354
1417
  /** Used to override the default configuration. */
1355
1418
  export declare interface CreateFileConfig {
1356
1419
  /** Used to override HTTP request options. */
@@ -1794,6 +1857,16 @@ export declare enum EditMode {
1794
1857
  EDIT_MODE_PRODUCT_IMAGE = "EDIT_MODE_PRODUCT_IMAGE"
1795
1858
  }
1796
1859
 
1860
+ /** Parameters for the embed_content method. */
1861
+ export declare interface EmbedContentBatch {
1862
+ /** The content to embed. Only the `parts.text` fields will be counted.
1863
+ */
1864
+ contents?: ContentListUnion;
1865
+ /** Configuration that contains optional parameters.
1866
+ */
1867
+ config?: EmbedContentConfig;
1868
+ }
1869
+
1797
1870
  /** Optional parameters for the embed_content method. */
1798
1871
  export declare interface EmbedContentConfig {
1799
1872
  /** Used to override HTTP request options. */
@@ -1862,6 +1935,16 @@ export declare class EmbedContentResponse {
1862
1935
  metadata?: EmbedContentMetadata;
1863
1936
  }
1864
1937
 
1938
+ export declare interface EmbeddingsBatchJobSource {
1939
+ /** The Gemini Developer API's file resource name of the input data
1940
+ (e.g. "files/12345").
1941
+ */
1942
+ fileName?: string;
1943
+ /** The Gemini Developer API's inlined input data to run batch job.
1944
+ */
1945
+ inlinedRequests?: EmbedContentBatch;
1946
+ }
1947
+
1865
1948
  /** Represents a customer-managed encryption key spec that can be applied to a top-level resource. */
1866
1949
  export declare interface EncryptionSpec {
1867
1950
  /** 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. */
@@ -3667,6 +3750,16 @@ export declare enum ImagePromptLanguage {
3667
3750
  es = "es"
3668
3751
  }
3669
3752
 
3753
+ /** Config for `inlined_embedding_responses` parameter. */
3754
+ export declare class InlinedEmbedContentResponse {
3755
+ /** The response to the request.
3756
+ */
3757
+ response?: SingleEmbedContentResponse;
3758
+ /** The error encountered while processing the request.
3759
+ */
3760
+ error?: JobError;
3761
+ }
3762
+
3670
3763
  /** Config for inlined request. */
3671
3764
  export declare interface InlinedRequest {
3672
3765
  /** ID of the model to use. For a list of models, see `Google models
@@ -5521,12 +5614,14 @@ export declare interface Part {
5521
5614
  /** An opaque signature for the thought so it can be reused in subsequent requests.
5522
5615
  * @remarks Encoded as base64 string. */
5523
5616
  thoughtSignature?: string;
5617
+ /** A predicted [FunctionCall] returned from the model that contains a string
5618
+ representing the [FunctionDeclaration.name] and a structured JSON object
5619
+ containing the parameters and their values. */
5620
+ functionCall?: FunctionCall;
5524
5621
  /** Optional. Result of executing the [ExecutableCode]. */
5525
5622
  codeExecutionResult?: CodeExecutionResult;
5526
5623
  /** Optional. Code generated by the model that is meant to be executed. */
5527
5624
  executableCode?: ExecutableCode;
5528
- /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
5529
- functionCall?: FunctionCall;
5530
5625
  /** 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. */
5531
5626
  functionResponse?: FunctionResponse;
5532
5627
  /** Optional. Text part (can be code). */
@@ -6284,6 +6379,16 @@ export declare interface SessionResumptionConfig {
6284
6379
  */
6285
6380
  export declare function setDefaultBaseUrls(baseUrlParams: BaseUrlParameters): void;
6286
6381
 
6382
+ /** Config for `response` parameter. */
6383
+ export declare class SingleEmbedContentResponse {
6384
+ /** The response to the request.
6385
+ */
6386
+ embedding?: ContentEmbedding;
6387
+ /** The error encountered while processing the request.
6388
+ */
6389
+ tokenCount?: string;
6390
+ }
6391
+
6287
6392
  /** Context window will be truncated by keeping only suffix of it.
6288
6393
 
6289
6394
  Context window will always be cut at start of USER role turn. System
@@ -7018,9 +7123,9 @@ declare namespace types {
7018
7123
  VideoMetadata,
7019
7124
  Blob_2 as Blob,
7020
7125
  FileData,
7126
+ FunctionCall,
7021
7127
  CodeExecutionResult,
7022
7128
  ExecutableCode,
7023
- FunctionCall,
7024
7129
  FunctionResponse,
7025
7130
  Part,
7026
7131
  Content,
@@ -7236,10 +7341,16 @@ declare namespace types {
7236
7341
  BatchJobSource,
7237
7342
  JobError,
7238
7343
  InlinedResponse,
7344
+ SingleEmbedContentResponse,
7345
+ InlinedEmbedContentResponse,
7239
7346
  BatchJobDestination,
7240
7347
  CreateBatchJobConfig,
7241
7348
  CreateBatchJobParameters,
7242
7349
  BatchJob,
7350
+ EmbedContentBatch,
7351
+ EmbeddingsBatchJobSource,
7352
+ CreateEmbeddingsBatchJobConfig,
7353
+ CreateEmbeddingsBatchJobParameters,
7243
7354
  GetBatchJobConfig,
7244
7355
  GetBatchJobParameters,
7245
7356
  CancelBatchJobConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google/genai",
3
- "version": "1.17.0",
3
+ "version": "1.18.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "main": "dist/node/index.mjs",