Package ai.extend.resources.batchruns

Class RawBatchRunsClient

java.lang.Object

ai.extend.resources.batchruns.RawBatchRunsClient

public class RawBatchRunsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawBatchRunsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ExtendClientHttpResponse<BatchRun>	get(java.lang.String id)	Retrieve the status of a batch run by its ID.
ExtendClientHttpResponse<BatchRun>	get(java.lang.String id, RequestOptions requestOptions)	Retrieve the status of a batch run by its ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

RawBatchRunsClient

public RawBatchRunsClient(ClientOptions clientOptions)

Method Detail

get

public ExtendClientHttpResponse<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 /parse_runs/batch, 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 type filtered by batchId:

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

get

public ExtendClientHttpResponse<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 /parse_runs/batch, 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 type filtered by batchId:

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