Interface BatchImageModel

All Known Implementing Classes:
GoogleAiGeminiBatchImageModel
@Experimental public interface BatchImageModel
A model interface for processing multiple image generation requests asynchronously in a batch.

Batch processing typically offers significant cost reductions compared to real-time requests and is ideal for large-scale, non-urgent tasks.

See Also:

  • Method Details

    • submit

      BatchResponse<Response<Image>> submit(BatchRequest<String> request)
      Creates a batch of image generation prompts and submits them for asynchronous processing.

      The returned BatchResponse represents the status of the batch operation.

      Parameters:
      request - the list of image generation prompts or requests to process
      Returns:
      a BatchResponse representing the initial state of the batch operation

    • retrieve

      BatchResponse<Response<Image>> retrieve(String batchId)
      Retrieves the current state and results of an image generation batch operation.

      The response indicates whether the batch is still processing, completed successfully, or failed. Once completed, the response will contain the generated image data.

      Parameters:
      batchId - the batch identifier obtained from submit(BatchRequest)
      Returns:
      a BatchResponse representing the current state of the image batch operation

    • cancel

      void cancel(String batchId)
      Cancels an image generation batch operation that is currently pending or running.
      Parameters:
      batchId - the batch identifier to cancel

    • list

      BatchPage<Response<Image>> list(@Nullable BatchPagination pagination)
      Lists image generation batch jobs with optional pagination.
      Parameters:
      pagination - the maximum number of batch jobs to return and token for retrieving a specific page; if null, uses server default
      Returns:
      a BatchPage containing image generation batch responses and pagination information