Package io.github.stefanbratanov.jvm.openai

Class RunStepsClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.RunStepsClient

public final class RunStepsClient
extends Object

Represents the steps (model and tool calls) taken during the run.

Based on Run Steps

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RunStepsClient.PaginatedThreadRunSteps

Method Summary

Modifier and Type	Method	Description
RunStepsClient.PaginatedThreadRunSteps	listRunSteps(String threadId, String runId, PaginationQueryParameters paginationQueryParameters, Optional<List<String>> include)	Returns a list of run steps belonging to a run.
ThreadRunStep	retrieveRunStep(String threadId, String runId, String stepId, Optional<List<String>> include)	Retrieves a run step.

Methods inherited from class java.lang.Object

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

Method Details

listRunSteps

public RunStepsClient.PaginatedThreadRunSteps listRunSteps(String threadId,
 String runId,
 PaginationQueryParameters paginationQueryParameters,
 Optional<List<String>> include)

Returns a list of run steps belonging to a run.

Parameters:

include - A list of additional fields to include in the response.

Throws:

OpenAIException - in case of API errors

retrieveRunStep

public ThreadRunStep retrieveRunStep(String threadId,
 String runId,
 String stepId,
 Optional<List<String>> include)

Retrieves a run step.

Parameters:

include - A list of additional fields to include in the response.

Throws:

OpenAIException - in case of API errors