Package com.openai.services.async
        Interface BatchServiceAsync
- 
                    
                    
- All Implemented Interfaces:
 
public interface BatchServiceAsync 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceBatchServiceAsync.WithRawResponseA view of BatchServiceAsync that provides access to raw HTTP responses for each method.
 
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
withRawResponse
abstract BatchServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
 
- 
                                        
withOptions
abstract BatchServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
 
- 
                                        
create
CompletableFuture<Batch> create(BatchCreateParams params)
Creates and executes a batch from an uploaded file of requests
 
- 
                                        
create
abstract CompletableFuture<Batch> create(BatchCreateParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
CompletableFuture<Batch> retrieve(String batchId)
Retrieves a batch.
 
- 
                                        
retrieve
CompletableFuture<Batch> retrieve(String batchId, BatchRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
CompletableFuture<Batch> retrieve(String batchId, BatchRetrieveParams params)
 
- 
                                        
retrieve
abstract CompletableFuture<Batch> retrieve(BatchRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
CompletableFuture<Batch> retrieve(BatchRetrieveParams params)
 
- 
                                        
retrieve
CompletableFuture<Batch> retrieve(String batchId, RequestOptions requestOptions)
 
- 
                                        
list
CompletableFuture<BatchListPageAsync> list()
List your organization's batches.
 
- 
                                        
list
abstract CompletableFuture<BatchListPageAsync> list(BatchListParams params, RequestOptions requestOptions)
 
- 
                                        
list
CompletableFuture<BatchListPageAsync> list(BatchListParams params)
 
- 
                                        
list
CompletableFuture<BatchListPageAsync> list(RequestOptions requestOptions)
 
- 
                                        
cancel
CompletableFuture<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
CompletableFuture<Batch> cancel(String batchId, BatchCancelParams params, RequestOptions requestOptions)
 
- 
                                        
cancel
CompletableFuture<Batch> cancel(String batchId, BatchCancelParams params)
 
- 
                                        
cancel
abstract CompletableFuture<Batch> cancel(BatchCancelParams params, RequestOptions requestOptions)
 
- 
                                        
cancel
CompletableFuture<Batch> cancel(BatchCancelParams params)
 
- 
                                        
cancel
CompletableFuture<Batch> cancel(String batchId, RequestOptions requestOptions)
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -