Package ai.extend.resources.batchruns

Class BatchRunsClient

  • public class BatchRunsClient
extends java.lang.Object

    • Constructor Detail

      • BatchRunsClient

        public BatchRunsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

        public RawBatchRunsClient withRawResponse()
        Get responses with HTTP metadata like headers

      • get

        public BatchRun get​(java.lang.String id)
        Retrieve the status of a batch run by its ID. The status field reflects the aggregate state of the batch.

        This is a unified endpoint that works for batches created via any of the batch submission endpoints (POST /extract_runs/batch, POST /classify_runs/batch, POST /split_runs/batch).

        | Status | Meaning | |---|---| | PENDING | Queued, not yet started | | PROCESSING | Runs are actively being processed | | PROCESSED | All runs have completed | | FAILED | The batch encountered a fatal error | | CANCELLED | The batch was cancelled |

        To retrieve individual run results, use the List endpoint for the relevant processor type filtered by batchId:

        • GET /extract_runs?batchId={id}
        • GET /classify_runs?batchId={id}
        • GET /split_runs?batchId={id}

      • get

        public BatchRun get​(java.lang.String id,
                    RequestOptions requestOptions)
        Retrieve the status of a batch run by its ID. The status field reflects the aggregate state of the batch.

        This is a unified endpoint that works for batches created via any of the batch submission endpoints (POST /extract_runs/batch, POST /classify_runs/batch, POST /split_runs/batch).

        | Status | Meaning | |---|---| | PENDING | Queued, not yet started | | PROCESSING | Runs are actively being processed | | PROCESSED | All runs have completed | | FAILED | The batch encountered a fatal error | | CANCELLED | The batch was cancelled |

        To retrieve individual run results, use the List endpoint for the relevant processor type filtered by batchId:

        • GET /extract_runs?batchId={id}
        • GET /classify_runs?batchId={id}
        • GET /split_runs?batchId={id}