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

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.
Stream<AssistantStreamEvent>	createRunAndStream(String threadId, CreateRunRequest request)	Create a run and stream the result of executing it.
void	createRunAndStream(String threadId, CreateRunRequest request, AssistantStreamEventSubscriber subscriber)	Same as createRunAndStream(String, CreateRunRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>
ThreadRun	createThreadAndRun(CreateThreadAndRunRequest request)	Create a thread and run it in one request.
Stream<AssistantStreamEvent>	createThreadAndRunAndStream(CreateThreadAndRunRequest request)	Create a thread and run it in one request and stream the result of executing it.
void	createThreadAndRunAndStream(CreateThreadAndRunRequest request, AssistantStreamEventSubscriber subscriber)	Same as createThreadAndRunAndStream(CreateThreadAndRunRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>
RunsClient.PaginatedThreadRuns	listRuns(String threadId, PaginationQueryParameters paginationQueryParameters)	Returns a list of runs belonging to a thread.
RunsClient.PaginatedThreadRunSteps	listRunSteps(String threadId, String runId, PaginationQueryParameters paginationQueryParameters)	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.
Stream<AssistantStreamEvent>	submitToolOutputsAndStream(String threadId, String runId, SubmitToolOutputsRequest request)	Same as submitToolOutputs(String, String, SubmitToolOutputsRequest) but the result of executing the thread run will be streamed
void	submitToolOutputsAndStream(String threadId, String runId, SubmitToolOutputsRequest request, AssistantStreamEventSubscriber subscriber)	Same as submitToolOutputsAndStream(String, String, SubmitToolOutputsRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>

Methods inherited from class java.lang.Object

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

Method Details

createRun

public ThreadRun createRun(String threadId,
 CreateRunRequest request)

Create a run.

Throws:

OpenAIException - in case of API errors

createRunAndStream

public Stream<AssistantStreamEvent> createRunAndStream(String threadId,
 CreateRunRequest request)

Create a run and stream the result of executing it.

Throws:

OpenAIException - in case of API errors

createRunAndStream

public void createRunAndStream(String threadId,
 CreateRunRequest request,
 AssistantStreamEventSubscriber subscriber)

Same as createRunAndStream(String, CreateRunRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>

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

createThreadAndRunAndStream

public Stream<AssistantStreamEvent> createThreadAndRunAndStream(CreateThreadAndRunRequest request)

Create a thread and run it in one request and stream the result of executing it.

Throws:

OpenAIException - in case of API errors

createThreadAndRunAndStream

public void createThreadAndRunAndStream(CreateThreadAndRunRequest request,
 AssistantStreamEventSubscriber subscriber)

Same as createThreadAndRunAndStream(CreateThreadAndRunRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>

Throws:

OpenAIException - in case of API errors

listRuns

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

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 paginationQueryParameters)

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

submitToolOutputsAndStream

public Stream<AssistantStreamEvent> submitToolOutputsAndStream(String threadId,
 String runId,
 SubmitToolOutputsRequest request)

Same as submitToolOutputs(String, String, SubmitToolOutputsRequest) but the result of executing the thread run will be streamed

Throws:

OpenAIException - in case of API errors

submitToolOutputsAndStream

public void submitToolOutputsAndStream(String threadId,
 String runId,
 SubmitToolOutputsRequest request,
 AssistantStreamEventSubscriber subscriber)

Same as submitToolOutputsAndStream(String, String, SubmitToolOutputsRequest) but can pass a AssistantStreamEventSubscriber implementation instead of using a Stream<AssistantStreamEvent>

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