Interface RunService
- 
                    
                    
- All Implemented Interfaces:
 
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") public interface RunService
 
- 
                
                    
                    
- 
                                
                            
                                
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceRunService.WithRawResponseA view of RunService that provides access to raw HTTP responses for each method.
 
- 
                                
                            
                                
Method Summary
- 
                    
                    
                    
- 
                                
                            
                                
Method Detail
- 
                                        
withRawResponse
abstract RunService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
 
- 
                                        
withOptions
abstract RunService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
 
- 
                                        
steps
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract StepService steps()
 
- 
                                        
create
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run create(String threadId, RunCreateParams params)
Create a run.
 
- 
                                        
create
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run create(String threadId, RunCreateParams params, RequestOptions requestOptions)
 
- 
                                        
create
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run create(RunCreateParams params)
 
- 
                                        
create
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract Run create(RunCreateParams params, RequestOptions requestOptions)
 
- 
                                        
createStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> createStreaming(String threadId, RunCreateParams params)
Create a run.
 
- 
                                        
createStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> createStreaming(String threadId, RunCreateParams params, RequestOptions requestOptions)
 
- 
                                        
createStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params)
 
- 
                                        
createStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() abstract StreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run retrieve(String runId, RunRetrieveParams params)
Retrieves a run.
 
- 
                                        
retrieve
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run retrieve(String runId, RunRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
retrieve
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run retrieve(RunRetrieveParams params)
 
- 
                                        
retrieve
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract Run retrieve(RunRetrieveParams params, RequestOptions requestOptions)
 
- 
                                        
update
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run update(String runId, RunUpdateParams params)
Modifies a run.
 
- 
                                        
update
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run update(String runId, RunUpdateParams params, RequestOptions requestOptions)
 
- 
                                        
update
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run update(RunUpdateParams params)
 
- 
                                        
update
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract Run update(RunUpdateParams params, RequestOptions requestOptions)
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") RunListPage list(String threadId)
Returns a list of runs belonging to a thread.
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") RunListPage list(String threadId, RunListParams params, RequestOptions requestOptions)
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") RunListPage list(String threadId, RunListParams params)
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract RunListPage list(RunListParams params, RequestOptions requestOptions)
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") RunListPage list(RunListParams params)
 
- 
                                        
list
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") RunListPage list(String threadId, RequestOptions requestOptions)
 
- 
                                        
cancel
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run cancel(String runId, RunCancelParams params)
Cancels a run that is
in_progress. 
- 
                                        
cancel
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run cancel(String runId, RunCancelParams params, RequestOptions requestOptions)
 
- 
                                        
cancel
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run cancel(RunCancelParams params)
 
- 
                                        
cancel
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract Run cancel(RunCancelParams params, RequestOptions requestOptions)
 
- 
                                        
submitToolOutputs
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run submitToolOutputs(String runId, RunSubmitToolOutputsParams params)
When a run has the
status: "requires_action"andrequired_action.typeissubmit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. 
- 
                                        
submitToolOutputs
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run submitToolOutputs(String runId, RunSubmitToolOutputsParams params, RequestOptions requestOptions)
 
- 
                                        
submitToolOutputs
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") Run submitToolOutputs(RunSubmitToolOutputsParams params)
 
- 
                                        
submitToolOutputs
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") abstract Run submitToolOutputs(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
 
- 
                                        
submitToolOutputsStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(String runId, RunSubmitToolOutputsParams params)
When a run has the
status: "requires_action"andrequired_action.typeissubmit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. 
- 
                                        
submitToolOutputsStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(String runId, RunSubmitToolOutputsParams params, RequestOptions requestOptions)
 
- 
                                        
submitToolOutputsStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(RunSubmitToolOutputsParams params)
 
- 
                                        
submitToolOutputsStreaming
@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API")@MustBeClosed() abstract StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
 
 - 
                                        
 
 - 
                                
                            
                                
 
 - 
                    
                    
                    
 
 -