Interface RunServiceAsync
-
- All Implemented Interfaces:
public interface RunServiceAsync
-
-
Method Summary
Modifier and Type Method Description abstract StepServiceAsync
steps()
abstract CompletableFuture<Run>
create(BetaThreadRunCreateParams params, RequestOptions requestOptions)
Create a run. abstract CompletableFuture<Run>
create(BetaThreadRunCreateParams params)
Create a run. abstract AsyncStreamResponse<AssistantStreamEvent>
createStreaming(BetaThreadRunCreateParams params, RequestOptions requestOptions)
Create a run. abstract AsyncStreamResponse<AssistantStreamEvent>
createStreaming(BetaThreadRunCreateParams params)
Create a run. abstract CompletableFuture<Run>
retrieve(BetaThreadRunRetrieveParams params, RequestOptions requestOptions)
Retrieves a run. abstract CompletableFuture<Run>
retrieve(BetaThreadRunRetrieveParams params)
Retrieves a run. abstract CompletableFuture<Run>
update(BetaThreadRunUpdateParams params, RequestOptions requestOptions)
Modifies a run. abstract CompletableFuture<Run>
update(BetaThreadRunUpdateParams params)
Modifies a run. abstract CompletableFuture<BetaThreadRunListPageAsync>
list(BetaThreadRunListParams params, RequestOptions requestOptions)
Returns a list of runs belonging to a thread. abstract CompletableFuture<BetaThreadRunListPageAsync>
list(BetaThreadRunListParams params)
Returns a list of runs belonging to a thread. abstract CompletableFuture<Run>
cancel(BetaThreadRunCancelParams params, RequestOptions requestOptions)
Cancels a run that is in_progress
.abstract CompletableFuture<Run>
cancel(BetaThreadRunCancelParams params)
Cancels a run that is in_progress
.abstract CompletableFuture<Run>
submitToolOutputs(BetaThreadRunSubmitToolOutputsParams params, RequestOptions requestOptions)
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(BetaThreadRunSubmitToolOutputsParams 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(BetaThreadRunSubmitToolOutputsParams params, RequestOptions requestOptions)
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(BetaThreadRunSubmitToolOutputsParams 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.-
-
Method Detail
-
steps
abstract StepServiceAsync steps()
-
create
abstract CompletableFuture<Run> create(BetaThreadRunCreateParams params, RequestOptions requestOptions)
Create a run.
-
create
abstract CompletableFuture<Run> create(BetaThreadRunCreateParams params)
Create a run.
-
createStreaming
abstract AsyncStreamResponse<AssistantStreamEvent> createStreaming(BetaThreadRunCreateParams params, RequestOptions requestOptions)
Create a run.
-
createStreaming
abstract AsyncStreamResponse<AssistantStreamEvent> createStreaming(BetaThreadRunCreateParams params)
Create a run.
-
retrieve
abstract CompletableFuture<Run> retrieve(BetaThreadRunRetrieveParams params, RequestOptions requestOptions)
Retrieves a run.
-
retrieve
abstract CompletableFuture<Run> retrieve(BetaThreadRunRetrieveParams params)
Retrieves a run.
-
update
abstract CompletableFuture<Run> update(BetaThreadRunUpdateParams params, RequestOptions requestOptions)
Modifies a run.
-
update
abstract CompletableFuture<Run> update(BetaThreadRunUpdateParams params)
Modifies a run.
-
list
abstract CompletableFuture<BetaThreadRunListPageAsync> list(BetaThreadRunListParams params, RequestOptions requestOptions)
Returns a list of runs belonging to a thread.
-
list
abstract CompletableFuture<BetaThreadRunListPageAsync> list(BetaThreadRunListParams params)
Returns a list of runs belonging to a thread.
-
cancel
abstract CompletableFuture<Run> cancel(BetaThreadRunCancelParams params, RequestOptions requestOptions)
Cancels a run that is
in_progress
.
-
cancel
abstract CompletableFuture<Run> cancel(BetaThreadRunCancelParams params)
Cancels a run that is
in_progress
.
-
submitToolOutputs
abstract CompletableFuture<Run> submitToolOutputs(BetaThreadRunSubmitToolOutputsParams params, RequestOptions requestOptions)
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(BetaThreadRunSubmitToolOutputsParams 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(BetaThreadRunSubmitToolOutputsParams params, RequestOptions requestOptions)
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(BetaThreadRunSubmitToolOutputsParams 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.
-
-
-
-