Package io.github.stefanbratanov.jvm.openai

Class RunsClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.RunsClient

public final class RunsClient
extends Object

Represents an execution run on a thread.

Based on Runs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RunsClient.PaginatedThreadRuns
static final record	RunsClient.PaginatedThreadRunSteps

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpClient	httpClient
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Method Summary

Modifier and Type	Method	Description
ThreadRun	cancelRun(String threadId, String runId)	Cancels a run that is in_progress.
ThreadRun	createRun(String threadId, CreateRunRequest request)	Create a run.
ThreadRun	createThreadAndRun(CreateThreadAndRunRequest request)	Create a thread and run it in one request.
RunsClient.PaginatedThreadRuns	listRuns(String threadId, PaginationQueryParameters queryParameters)	Returns a list of runs belonging to a thread.
RunsClient.PaginatedThreadRunSteps	listRunSteps(String threadId, String runId, PaginationQueryParameters queryParameters)	Returns a list of run steps belonging to a run.
ThreadRun	modifyRun(String threadId, String runId, ModifyRunRequest request)	Modifies a run.
ThreadRun	retrieveRun(String threadId, String runId)	Retrieves a run.
ThreadRunStep	retrieveRunStep(String threadId, String runId, String stepId)	Retrieves a run step.
ThreadRun	submitToolOutputs(String threadId, String runId, SubmitToolOutputsRequest request)	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

httpClient

protected final HttpClient httpClient

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Method Details

createRun

public ThreadRun createRun(String threadId,
 CreateRunRequest request)

Create a run.

Throws:

OpenAIException - in case of API errors

createThreadAndRun

public ThreadRun createThreadAndRun(CreateThreadAndRunRequest request)

Create a thread and run it in one request.

Throws:

OpenAIException - in case of API errors

listRuns

public RunsClient.PaginatedThreadRuns listRuns(String threadId,
 PaginationQueryParameters queryParameters)

Returns a list of runs belonging to a thread.

Throws:

OpenAIException - in case of API errors

listRunSteps

public RunsClient.PaginatedThreadRunSteps listRunSteps(String threadId,
 String runId,
 PaginationQueryParameters queryParameters)

Returns a list of run steps belonging to a run.

Throws:

OpenAIException - in case of API errors

retrieveRun

public ThreadRun retrieveRun(String threadId,
 String runId)

Retrieves a run.

Throws:

OpenAIException - in case of API errors

retrieveRunStep

public ThreadRunStep retrieveRunStep(String threadId,
 String runId,
 String stepId)

Retrieves a run step.

Throws:

OpenAIException - in case of API errors

modifyRun

public ThreadRun modifyRun(String threadId,
 String runId,
 ModifyRunRequest request)

Modifies a run.

Throws:

OpenAIException - in case of API errors

submitToolOutputs

public ThreadRun submitToolOutputs(String threadId,
 String runId,
 SubmitToolOutputsRequest request)

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.

Throws:

OpenAIException - in case of API errors

cancelRun

public ThreadRun cancelRun(String threadId,
 String runId)

Cancels a run that is in_progress.

Throws:

OpenAIException - in case of API errors