feat: add complete stats to BatchJob

PiperOrigin-RevId: 828312096

Author: yyyu-google

api-report/genai-node.api.md

@@ -172,6 +172,7 @@ export class Batches extends BaseModule {
 
 // @public
 export interface BatchJob {
+    completionStats?: CompletionStats;
     createTime?: string;
     dest?: BatchJobDestination;
     displayName?: string;
@@ -363,6 +364,14 @@ export interface CodeExecutionResult {
     output?: string;
 }
 
+// @public
+export interface CompletionStats {
+    failedCount?: string;
+    incompleteCount?: string;
+    successfulCount?: string;
+    successfulForecastPointCount?: string;
+}
+
 // @public
 export interface ComputerUse {
     environment?: Environment;

api-report/genai-web.api.md

@@ -172,6 +172,7 @@ export class Batches extends BaseModule {
 
 // @public
 export interface BatchJob {
+    completionStats?: CompletionStats;
     createTime?: string;
     dest?: BatchJobDestination;
     displayName?: string;
@@ -363,6 +364,14 @@ export interface CodeExecutionResult {
     output?: string;
 }
 
+// @public
+export interface CompletionStats {
+    failedCount?: string;
+    incompleteCount?: string;
+    successfulCount?: string;
+    successfulForecastPointCount?: string;
+}
+
 // @public
 export interface ComputerUse {
     environment?: Environment;

api-report/genai.api.md

@@ -172,6 +172,7 @@ export class Batches extends BaseModule {
 
 // @public
 export interface BatchJob {
+    completionStats?: CompletionStats;
     createTime?: string;
     dest?: BatchJobDestination;
     displayName?: string;
@@ -363,6 +364,14 @@ export interface CodeExecutionResult {
     output?: string;
 }
 
+// @public
+export interface CompletionStats {
+    failedCount?: string;
+    incompleteCount?: string;
+    successfulCount?: string;
+    successfulForecastPointCount?: string;
+}
+
 // @public
 export interface ComputerUse {
     environment?: Environment;

src/converters/_batches_converters.ts

@@ -263,6 +263,13 @@ export function batchJobFromVertex(
     );
   }
 
+  const fromCompletionStats = common.getValueByPath(fromObject, [
+    'completionStats',
+  ]);
+  if (fromCompletionStats != null) {
+    common.setValueByPath(toObject, ['completionStats'], fromCompletionStats);
+  }
+
   return toObject;
 }
 

src/types.ts

@@ -4822,6 +4822,18 @@ export declare interface CreateBatchJobParameters {
   config?: CreateBatchJobConfig;
 }
 
+/** Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. This data type is not supported in Gemini API. */
+export declare interface CompletionStats {
+  /** Output only. The number of entities for which any error was encountered. */
+  failedCount?: string;
+  /** Output only. In cases when enough errors are encountered a job, pipeline, or operation may be failed as a whole. Below is the number of entities for which the processing had not been finished (either in successful or failed state). Set to -1 if the number is unknown (for example, the operation failed before the total entity number could be collected). */
+  incompleteCount?: string;
+  /** Output only. The number of entities that had been processed successfully. */
+  successfulCount?: string;
+  /** Output only. The number of the successful forecast points that are generated by the forecasting model. This is ONLY used by the forecasting batch prediction. */
+  successfulForecastPointCount?: string;
+}
+
 /** Config for batches.create return value. */
 export declare interface BatchJob {
   /** The resource name of the BatchJob. Output only.".
@@ -4840,7 +4852,7 @@ export declare interface BatchJob {
   createTime?: string;
   /** Output only. Time when the Job for the first time entered the `JOB_STATE_RUNNING` state. */
   startTime?: string;
-  /** The time when the BatchJob was completed.
+  /** The time when the BatchJob was completed. This field is for Vertex AI only.
    */
   endTime?: string;
   /** The time when the BatchJob was last updated.
@@ -4849,12 +4861,15 @@ export declare interface BatchJob {
   /** The name of the model that produces the predictions via the BatchJob.
    */
   model?: string;
-  /** Configuration for the input data.
+  /** Configuration for the input data. This field is for Vertex AI only.
    */
   src?: BatchJobSource;
   /** Configuration for the output data.
    */
   dest?: BatchJobDestination;
+  /** Statistics on completed and failed prediction instances. This field is for Vertex AI only.
+   */
+  completionStats?: CompletionStats;
 }
 
 /** Parameters for the embed_content method. */