Package com.openai.services.blocking
Interface BatchService
-
- All Implemented Interfaces:
public interface BatchService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
BatchService.WithRawResponse
A view of BatchService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract BatchService.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. Batch
create(BatchCreateParams params)
Creates and executes a batch from an uploaded file of requests abstract Batch
create(BatchCreateParams params, RequestOptions requestOptions)
Batch
retrieve(BatchRetrieveParams params)
Retrieves a batch. abstract Batch
retrieve(BatchRetrieveParams params, RequestOptions requestOptions)
BatchListPage
list()
List your organization's batches. abstract BatchListPage
list(BatchListParams params, RequestOptions requestOptions)
BatchListPage
list(BatchListParams params)
BatchListPage
list(RequestOptions requestOptions)
Batch
cancel(BatchCancelParams params)
Cancels an in-progress batch. abstract Batch
cancel(BatchCancelParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract BatchService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
create
Batch create(BatchCreateParams params)
Creates and executes a batch from an uploaded file of requests
-
create
abstract Batch create(BatchCreateParams params, RequestOptions requestOptions)
-
retrieve
Batch retrieve(BatchRetrieveParams params)
Retrieves a batch.
-
retrieve
abstract Batch retrieve(BatchRetrieveParams params, RequestOptions requestOptions)
-
list
BatchListPage list()
List your organization's batches.
-
list
abstract BatchListPage list(BatchListParams params, RequestOptions requestOptions)
-
list
BatchListPage list(BatchListParams params)
-
list
BatchListPage list(RequestOptions requestOptions)
-
cancel
Batch cancel(BatchCancelParams params)
Cancels an in-progress batch. The batch will be in status
cancelling
for up to 10 minutes, before changing tocancelled
, where it will have partial results (if any) available in the output file.
-
cancel
abstract Batch cancel(BatchCancelParams params, RequestOptions requestOptions)
-
-
-
-