Package com.openai.services.blocking
Interface BatchService
-
- All Implemented Interfaces:
public interface BatchService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceBatchService.WithRawResponseA view of BatchService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract BatchService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract BatchServicewithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. Batchcreate(BatchCreateParams params)Creates and executes a batch from an uploaded file of requests abstract Batchcreate(BatchCreateParams params, RequestOptions requestOptions)Batchretrieve(String batchId)Retrieves a batch. Batchretrieve(String batchId, BatchRetrieveParams params, RequestOptions requestOptions)Batchretrieve(String batchId, BatchRetrieveParams params)abstract Batchretrieve(BatchRetrieveParams params, RequestOptions requestOptions)Batchretrieve(BatchRetrieveParams params)Batchretrieve(String batchId, RequestOptions requestOptions)BatchListPagelist()List your organization's batches. abstract BatchListPagelist(BatchListParams params, RequestOptions requestOptions)BatchListPagelist(BatchListParams params)BatchListPagelist(RequestOptions requestOptions)Batchcancel(String batchId)Cancels an in-progress batch. Batchcancel(String batchId, BatchCancelParams params, RequestOptions requestOptions)Batchcancel(String batchId, BatchCancelParams params)abstract Batchcancel(BatchCancelParams params, RequestOptions requestOptions)Batchcancel(BatchCancelParams params)Batchcancel(String batchId, 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.
-
withOptions
abstract BatchService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
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(String batchId, BatchRetrieveParams params, RequestOptions requestOptions)
-
retrieve
Batch retrieve(String batchId, BatchRetrieveParams params)
-
retrieve
abstract Batch retrieve(BatchRetrieveParams params, RequestOptions requestOptions)
-
retrieve
Batch retrieve(BatchRetrieveParams params)
-
retrieve
Batch retrieve(String batchId, 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(String batchId)
Cancels an in-progress batch. The batch will be in status
cancellingfor up to 10 minutes, before changing tocancelled, where it will have partial results (if any) available in the output file.
-
cancel
Batch cancel(String batchId, BatchCancelParams params, RequestOptions requestOptions)
-
cancel
Batch cancel(String batchId, BatchCancelParams params)
-
cancel
abstract Batch cancel(BatchCancelParams params, RequestOptions requestOptions)
-
cancel
Batch cancel(BatchCancelParams params)
-
cancel
Batch cancel(String batchId, RequestOptions requestOptions)
-
-
-
-