Interface RunService
-
- All Implemented Interfaces:
public interface RunService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
RunService.WithRawResponse
A view of RunService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract RunService.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. abstract StepService
steps()
Run
create(RunCreateParams params)
Create a run. abstract Run
create(RunCreateParams params, RequestOptions requestOptions)
StreamResponse<AssistantStreamEvent>
createStreaming(RunCreateParams params)
Create a run. abstract StreamResponse<AssistantStreamEvent>
createStreaming(RunCreateParams params, RequestOptions requestOptions)
Run
retrieve(RunRetrieveParams params)
Retrieves a run. abstract Run
retrieve(RunRetrieveParams params, RequestOptions requestOptions)
Run
update(RunUpdateParams params)
Modifies a run. abstract Run
update(RunUpdateParams params, RequestOptions requestOptions)
RunListPage
list(RunListParams params)
Returns a list of runs belonging to a thread. abstract RunListPage
list(RunListParams params, RequestOptions requestOptions)
Run
cancel(RunCancelParams params)
Cancels a run that is in_progress
.abstract Run
cancel(RunCancelParams params, RequestOptions requestOptions)
Run
submitToolOutputs(RunSubmitToolOutputsParams params)
When a run has the status: "requires_action"
andrequired_action.type
issubmit_tool_outputs
, this endpoint can be used to submit the outputs from the tool calls once they're all completed.abstract Run
submitToolOutputs(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
StreamResponse<AssistantStreamEvent>
submitToolOutputsStreaming(RunSubmitToolOutputsParams params)
When a run has the status: "requires_action"
andrequired_action.type
issubmit_tool_outputs
, this endpoint can be used to submit the outputs from the tool calls once they're all completed.abstract StreamResponse<AssistantStreamEvent>
submitToolOutputsStreaming(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract RunService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
steps
abstract StepService steps()
-
create
Run create(RunCreateParams params)
Create a run.
-
create
abstract Run create(RunCreateParams params, RequestOptions requestOptions)
-
createStreaming
@MustBeClosed() StreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params)
Create a run.
-
createStreaming
@MustBeClosed() abstract StreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params, RequestOptions requestOptions)
-
retrieve
Run retrieve(RunRetrieveParams params)
Retrieves a run.
-
retrieve
abstract Run retrieve(RunRetrieveParams params, RequestOptions requestOptions)
-
update
Run update(RunUpdateParams params)
Modifies a run.
-
update
abstract Run update(RunUpdateParams params, RequestOptions requestOptions)
-
list
RunListPage list(RunListParams params)
Returns a list of runs belonging to a thread.
-
list
abstract RunListPage list(RunListParams params, RequestOptions requestOptions)
-
cancel
Run cancel(RunCancelParams params)
Cancels a run that is
in_progress
.
-
cancel
abstract Run cancel(RunCancelParams params, RequestOptions requestOptions)
-
submitToolOutputs
Run submitToolOutputs(RunSubmitToolOutputsParams params)
When a run has the
status: "requires_action"
andrequired_action.type
issubmit_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
abstract Run submitToolOutputs(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
submitToolOutputsStreaming
@MustBeClosed() StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(RunSubmitToolOutputsParams params)
When a run has the
status: "requires_action"
andrequired_action.type
issubmit_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
@MustBeClosed() abstract StreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
-
-
-