Interface IRunService

Namespace

OpenAI.Interfaces

Assembly

AntRunnerLib.dll

public interface IRunService

Methods

CreateThreadAndRun(CreateThreadAndRunRequest, CancellationToken)

Create a thread and run it in one request.

Task<RunResponse> CreateThreadAndRun(CreateThreadAndRunRequest requestBody, CancellationToken cancellationToken = null)

Parameters

requestBody CreateThreadAndRunRequest

cancellationToken CancellationToken

Returns

Task<RunResponse>

ListRuns(String, PaginationRequest, CancellationToken)

Returns a list of runs belonging to a thread.

Task<RunListResponse> ListRuns(string threadId, PaginationRequest runListRequest, CancellationToken cancellationToken = null)

Parameters

threadId System.String

runListRequest PaginationRequest

cancellationToken CancellationToken

Returns

Task<RunListResponse>

RunCancel(String, String, CancellationToken)

Cancels a run that is in_progress.

Task<RunResponse> RunCancel(string threadId, string runId, CancellationToken cancellationToken = null)

Parameters

threadId System.String

runId System.String

cancellationToken CancellationToken

Returns

Task<RunResponse>

RunCreate(String, RunCreateRequest, String, CancellationToken)

Create a run.

Task<RunResponse> RunCreate(string threadId, RunCreateRequest request, string modelId = null, CancellationToken cancellationToken = null)

Parameters

threadId System.String

request RunCreateRequest

modelId System.String

cancellationToken CancellationToken

Returns

Task<RunResponse>

RunModify(String, String, RunModifyRequest, CancellationToken)

Modifies a run.

Task<RunResponse> RunModify(string threadId, string runId, RunModifyRequest request, CancellationToken cancellationToken = null)

Parameters

threadId System.String

The ID of the thread that was run.

runId System.String

The ID of the run to modify.

request RunModifyRequest

cancellationToken CancellationToken

Returns

Task<RunResponse>

RunRetrieve(String, String, CancellationToken)

Retrieves a run.

Task<RunResponse> RunRetrieve(string threadId, string runId, CancellationToken cancellationToken = null)

Parameters

threadId System.String

runId System.String

cancellationToken CancellationToken

Returns

Task<RunResponse>

RunSubmitToolOutputs(String, String, SubmitToolOutputsToRunRequest, CancellationToken)

Submit tool outputs to run

When a run has the status: "requires_action" and required_action.type is submit_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.

Task<RunResponse> RunSubmitToolOutputs(string threadId, string runId, SubmitToolOutputsToRunRequest request, CancellationToken cancellationToken = null)

Parameters

threadId System.String

runId System.String

request SubmitToolOutputsToRunRequest

cancellationToken CancellationToken

Returns

Task<RunResponse>