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