Interface RunServiceAsync
-
- All Implemented Interfaces:
public interface RunServiceAsync
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interface
RunServiceAsync.WithRawResponse
A view of RunServiceAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract RunServiceAsync.WithRawResponse
withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method. abstract StepServiceAsync
steps()
CompletableFuture<Run>
create(RunCreateParams params)
Create a run. abstract CompletableFuture<Run>
create(RunCreateParams params, RequestOptions requestOptions)
AsyncStreamResponse<AssistantStreamEvent>
createStreaming(RunCreateParams params)
Create a run. abstract AsyncStreamResponse<AssistantStreamEvent>
createStreaming(RunCreateParams params, RequestOptions requestOptions)
CompletableFuture<Run>
retrieve(RunRetrieveParams params)
Retrieves a run. abstract CompletableFuture<Run>
retrieve(RunRetrieveParams params, RequestOptions requestOptions)
CompletableFuture<Run>
update(RunUpdateParams params)
Modifies a run. abstract CompletableFuture<Run>
update(RunUpdateParams params, RequestOptions requestOptions)
CompletableFuture<RunListPageAsync>
list(RunListParams params)
Returns a list of runs belonging to a thread. abstract CompletableFuture<RunListPageAsync>
list(RunListParams params, RequestOptions requestOptions)
CompletableFuture<Run>
cancel(RunCancelParams params)
Cancels a run that is in_progress
.abstract CompletableFuture<Run>
cancel(RunCancelParams params, RequestOptions requestOptions)
CompletableFuture<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 CompletableFuture<Run>
submitToolOutputs(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
AsyncStreamResponse<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 AsyncStreamResponse<AssistantStreamEvent>
submitToolOutputsStreaming(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
-
Method Detail
-
withRawResponse
abstract RunServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
steps
abstract StepServiceAsync steps()
-
create
CompletableFuture<Run> create(RunCreateParams params)
Create a run.
-
create
abstract CompletableFuture<Run> create(RunCreateParams params, RequestOptions requestOptions)
-
createStreaming
AsyncStreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params)
Create a run.
-
createStreaming
abstract AsyncStreamResponse<AssistantStreamEvent> createStreaming(RunCreateParams params, RequestOptions requestOptions)
-
retrieve
CompletableFuture<Run> retrieve(RunRetrieveParams params)
Retrieves a run.
-
retrieve
abstract CompletableFuture<Run> retrieve(RunRetrieveParams params, RequestOptions requestOptions)
-
update
CompletableFuture<Run> update(RunUpdateParams params)
Modifies a run.
-
update
abstract CompletableFuture<Run> update(RunUpdateParams params, RequestOptions requestOptions)
-
list
CompletableFuture<RunListPageAsync> list(RunListParams params)
Returns a list of runs belonging to a thread.
-
list
abstract CompletableFuture<RunListPageAsync> list(RunListParams params, RequestOptions requestOptions)
-
cancel
CompletableFuture<Run> cancel(RunCancelParams params)
Cancels a run that is
in_progress
.
-
cancel
abstract CompletableFuture<Run> cancel(RunCancelParams params, RequestOptions requestOptions)
-
submitToolOutputs
CompletableFuture<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 CompletableFuture<Run> submitToolOutputs(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
submitToolOutputsStreaming
AsyncStreamResponse<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
abstract AsyncStreamResponse<AssistantStreamEvent> submitToolOutputsStreaming(RunSubmitToolOutputsParams params, RequestOptions requestOptions)
-
-
-
-