feat: Add Vertex Dataset input and output options for batch jobs

PiperOrigin-RevId: 902490891

Author: cleop-google

api-report/genai-node.api.md

@@ -239,6 +239,7 @@ export interface BatchJobDestination {
     gcsUri?: string;
     inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
     inlinedResponses?: InlinedResponse[];
+    vertexDataset?: VertexMultimodalDatasetDestination;
 }
 
 // @public (undocumented)
@@ -251,6 +252,7 @@ export interface BatchJobSource {
     format?: string;
     gcsUri?: string[];
     inlinedRequests?: InlinedRequest[];
+    vertexDatasetName?: string;
 }
 
 // @public (undocumented)
@@ -4127,6 +4129,12 @@ export interface VertexAISearchDataStoreSpec {
     filter?: string;
 }
 
+// @public
+export interface VertexMultimodalDatasetDestination {
+    bigqueryDestination?: string;
+    displayName?: string;
+}
+
 // @public
 export interface VertexRagStore {
     ragCorpora?: string[];

api-report/genai-web.api.md

@@ -239,6 +239,7 @@ export interface BatchJobDestination {
     gcsUri?: string;
     inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
     inlinedResponses?: InlinedResponse[];
+    vertexDataset?: VertexMultimodalDatasetDestination;
 }
 
 // @public (undocumented)
@@ -251,6 +252,7 @@ export interface BatchJobSource {
     format?: string;
     gcsUri?: string[];
     inlinedRequests?: InlinedRequest[];
+    vertexDatasetName?: string;
 }
 
 // @public (undocumented)
@@ -4127,6 +4129,12 @@ export interface VertexAISearchDataStoreSpec {
     filter?: string;
 }
 
+// @public
+export interface VertexMultimodalDatasetDestination {
+    bigqueryDestination?: string;
+    displayName?: string;
+}
+
 // @public
 export interface VertexRagStore {
     ragCorpora?: string[];

api-report/genai.api.md

@@ -239,6 +239,7 @@ export interface BatchJobDestination {
     gcsUri?: string;
     inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
     inlinedResponses?: InlinedResponse[];
+    vertexDataset?: VertexMultimodalDatasetDestination;
 }
 
 // @public (undocumented)
@@ -251,6 +252,7 @@ export interface BatchJobSource {
     format?: string;
     gcsUri?: string[];
     inlinedRequests?: InlinedRequest[];
+    vertexDatasetName?: string;
 }
 
 // @public (undocumented)
@@ -4127,6 +4129,12 @@ export interface VertexAISearchDataStoreSpec {
     filter?: string;
 }
 
+// @public
+export interface VertexMultimodalDatasetDestination {
+    bigqueryDestination?: string;
+    displayName?: string;
+}
+
 // @public
 export interface VertexRagStore {
     ragCorpora?: string[];

src/_transformers.ts

@@ -789,6 +789,10 @@ export function tBatchJobSource(
         sourceObj = {format: 'jsonl', gcsUri: [src]};
       } else if (src.startsWith('bq://')) {
         sourceObj = {format: 'bigquery', bigqueryUri: src};
+      } else if (
+        /^projects\/[^/]+\/locations\/[^/]+\/datasets\/[^/]+$/.test(src)
+      ) {
+        sourceObj = {format: 'vertex-dataset', vertexDatasetName: src};
       } else {
         throw new Error(`Unsupported string source for Vertex AI: ${src}`);
       }
@@ -811,9 +815,11 @@ export function tBatchJobSource(
   }
 
   // Validation logic
-  const vertexSourcesCount = [sourceObj.gcsUri, sourceObj.bigqueryUri].filter(
-    Boolean,
-  ).length;
+  const vertexSourcesCount = [
+    sourceObj.gcsUri,
+    sourceObj.bigqueryUri,
+    sourceObj.vertexDatasetName,
+  ].filter(Boolean).length;
 
   const mldevSourcesCount = [
     sourceObj.inlinedRequests,
@@ -823,7 +829,7 @@ export function tBatchJobSource(
   if (client.isVertexAI()) {
     if (mldevSourcesCount > 0 || vertexSourcesCount !== 1) {
       throw new Error(
-        'Exactly one of `gcsUri` or `bigqueryUri` must be set for Vertex AI.',
+        'Exactly one of `gcsUri`, `bigqueryUri`, or `vertexDatasetName` must be set for Vertex AI.',
       );
     }
   } else {

src/converters/_batches_converters.ts

@@ -128,6 +128,17 @@ export function batchJobDestinationFromVertex(
     common.setValueByPath(toObject, ['bigqueryUri'], fromBigqueryUri);
   }
 
+  const fromVertexDataset = common.getValueByPath(fromObject, [
+    'vertexMultimodalDatasetDestination',
+  ]);
+  if (fromVertexDataset != null) {
+    common.setValueByPath(
+      toObject,
+      ['vertexDataset'],
+      vertexMultimodalDatasetDestinationFromVertex(fromVertexDataset),
+    );
+  }
+
   return toObject;
 }
 
@@ -178,6 +189,17 @@ export function batchJobDestinationToVertex(
     );
   }
 
+  const fromVertexDataset = common.getValueByPath(fromObject, [
+    'vertexDataset',
+  ]);
+  if (fromVertexDataset != null) {
+    common.setValueByPath(
+      toObject,
+      ['vertexMultimodalDatasetDestination'],
+      vertexMultimodalDatasetDestinationToVertex(fromVertexDataset),
+    );
+  }
+
   return toObject;
 }
 
@@ -342,6 +364,18 @@ export function batchJobSourceFromVertex(
     common.setValueByPath(toObject, ['bigqueryUri'], fromBigqueryUri);
   }
 
+  const fromVertexDatasetName = common.getValueByPath(fromObject, [
+    'vertexMultimodalDatasetSource',
+    'datasetName',
+  ]);
+  if (fromVertexDatasetName != null) {
+    common.setValueByPath(
+      toObject,
+      ['vertexDatasetName'],
+      fromVertexDatasetName,
+    );
+  }
+
   return toObject;
 }
 
@@ -381,6 +415,12 @@ export function batchJobSourceToMldev(
     common.setValueByPath(toObject, ['requests', 'requests'], transformedList);
   }
 
+  if (common.getValueByPath(fromObject, ['vertexDatasetName']) !== undefined) {
+    throw new Error(
+      'vertexDatasetName parameter is not supported in Gemini API.',
+    );
+  }
+
   return toObject;
 }
 
@@ -416,6 +456,17 @@ export function batchJobSourceToVertex(
     throw new Error('inlinedRequests parameter is not supported in Vertex AI.');
   }
 
+  const fromVertexDatasetName = common.getValueByPath(fromObject, [
+    'vertexDatasetName',
+  ]);
+  if (fromVertexDatasetName != null) {
+    common.setValueByPath(
+      toObject,
+      ['vertexMultimodalDatasetSource', 'datasetName'],
+      fromVertexDatasetName,
+    );
+  }
+
   return toObject;
 }
 
@@ -1989,3 +2040,52 @@ export function toolToMldev(fromObject: types.Tool): Record<string, unknown> {
 
   return toObject;
 }
+
+export function vertexMultimodalDatasetDestinationFromVertex(
+  fromObject: types.VertexMultimodalDatasetDestination,
+): Record<string, unknown> {
+  const toObject: Record<string, unknown> = {};
+
+  const fromBigqueryDestination = common.getValueByPath(fromObject, [
+    'bigqueryDestination',
+    'outputUri',
+  ]);
+  if (fromBigqueryDestination != null) {
+    common.setValueByPath(
+      toObject,
+      ['bigqueryDestination'],
+      fromBigqueryDestination,
+    );
+  }
+
+  const fromDisplayName = common.getValueByPath(fromObject, ['displayName']);
+  if (fromDisplayName != null) {
+    common.setValueByPath(toObject, ['displayName'], fromDisplayName);
+  }
+
+  return toObject;
+}
+
+export function vertexMultimodalDatasetDestinationToVertex(
+  fromObject: types.VertexMultimodalDatasetDestination,
+): Record<string, unknown> {
+  const toObject: Record<string, unknown> = {};
+
+  const fromBigqueryDestination = common.getValueByPath(fromObject, [
+    'bigqueryDestination',
+  ]);
+  if (fromBigqueryDestination != null) {
+    common.setValueByPath(
+      toObject,
+      ['bigqueryDestination', 'outputUri'],
+      fromBigqueryDestination,
+    );
+  }
+
+  const fromDisplayName = common.getValueByPath(fromObject, ['displayName']);
+  if (fromDisplayName != null) {
+    common.setValueByPath(toObject, ['displayName'], fromDisplayName);
+  }
+
+  return toObject;
+}

src/types.ts

@@ -6156,7 +6156,7 @@ export declare interface InlinedRequest {
 /** Config for `src` parameter. */
 export declare interface BatchJobSource {
   /** Storage format of the input files. Must be one of:
-      'jsonl', 'bigquery'.
+      'jsonl', 'bigquery', 'vertex-dataset'.
        */
   format?: string;
   /** The Google Cloud Storage URIs to input files.
@@ -6172,6 +6172,19 @@ export declare interface BatchJobSource {
   /** The Gemini Developer API's inlined input data to run batch job.
    */
   inlinedRequests?: InlinedRequest[];
+  /** This field is experimental and may change in future versions. The Vertex AI dataset resource name to use as input. Must be of type multimodal.
+   */
+  vertexDatasetName?: string;
+}
+
+/** This class is experimental and may change in future versions.
+
+The specification for an output Vertex AI multimodal dataset. */
+export declare interface VertexMultimodalDatasetDestination {
+  /** The BigQuery destination for the multimodal dataset. */
+  bigqueryDestination?: string;
+  /** The display name of the multimodal dataset. */
+  displayName?: string;
 }
 
 /** Job error. */
@@ -6219,7 +6232,7 @@ export class InlinedEmbedContentResponse {
 /** Config for `des` parameter. */
 export declare interface BatchJobDestination {
   /** Storage format of the output files. Must be one of:
-      'jsonl', 'bigquery'.
+      'jsonl', 'bigquery', 'vertex-dataset'.
        */
   format?: string;
   /** The Google Cloud Storage URI to the output file.
@@ -6245,6 +6258,9 @@ export declare interface BatchJobDestination {
       the input requests.
        */
   inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
+  /** This field is experimental and may change in future versions. The Vertex AI dataset destination.
+   */
+  vertexDataset?: VertexMultimodalDatasetDestination;
 }
 
 /** Config for optional parameters. */