Package io.github.sashirestela.openai

Interface OpenAIBeta2.ThreadRunSteps

Enclosing interface:

OpenAIBeta2

@Resource("/v1/threads/{threadId}/runs/{runId}/steps")
@Header(name="OpenAI-Beta",
        value="assistants=v2")
public static interface OpenAIBeta2.ThreadRunSteps

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

See Also:

Thread Run Steps

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<Page<ThreadRunStep>>	getList(String threadId, String runId)	Returns a list of run steps belonging to a run (first page).
CompletableFuture<Page<ThreadRunStep>>	getList(String threadId, String runId, PageRequest page)	Returns a list of run steps belonging to a run.
default CompletableFuture<ThreadRunStep>	getOne(String threadId, String runId, String stepId)	Retrieves a run step.
CompletableFuture<ThreadRunStep>	getOnePrimitive(String threadId, String runId, String stepId, ThreadRunStepQuery include)	Retrieves a run step (don't call it directly).
default CompletableFuture<ThreadRunStep>	getOneWithFileSearchResult(String threadId, String runId, String stepId)	Retrieves a run step including File Search result contents.

Method Detail

getList

@GET
CompletableFuture<Page<ThreadRunStep>> getList(@Path("threadId")
                                               String threadId,
                                               @Path("runId")
                                               String runId,
                                               @Query
                                               PageRequest page)

Returns a list of run steps belonging to a run.

Parameters:

threadId - The ID of the thread the run and run steps belong to.

runId - The ID of the run the run steps belong to.

page - The page filter to narrow the list.

Returns:

A list of run step objects.

getList

default CompletableFuture<Page<ThreadRunStep>> getList(String threadId,
                                                       String runId)

Returns a list of run steps belonging to a run (first page).

Parameters:

threadId - The ID of the thread the run and run steps belong to.

runId - The ID of the run the run steps belong to.

Returns:

A list of run step objects.

getOnePrimitive

@GET("/{stepId}")
CompletableFuture<ThreadRunStep> getOnePrimitive(@Path("threadId")
                                                 String threadId,
                                                 @Path("runId")
                                                 String runId,
                                                 @Path("stepId")
                                                 String stepId,
                                                 @Query("include[]")
                                                 ThreadRunStepQuery include)

Retrieves a run step (don't call it directly).

Parameters:

threadId - The ID of the thread to which the run and run step belongs.

runId - The ID of the run to which the run step belongs.

stepId - The ID of the run step to retrieve.

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

Returns:

The run step object matching the specified ID.

getOne

@GET("/{stepId}")
default CompletableFuture<ThreadRunStep> getOne(@Path("threadId")
                                                String threadId,
                                                @Path("runId")
                                                String runId,
                                                @Path("stepId")
                                                String stepId)

Retrieves a run step.

Parameters:

threadId - The ID of the thread to which the run and run step belongs.

runId - The ID of the run to which the run step belongs.

stepId - The ID of the run step to retrieve.

Returns:

The run step object matching the specified ID.

getOneWithFileSearchResult

@GET("/{stepId}")
default CompletableFuture<ThreadRunStep> getOneWithFileSearchResult(@Path("threadId")
                                                                    String threadId,
                                                                    @Path("runId")
                                                                    String runId,
                                                                    @Path("stepId")
                                                                    String stepId)

Retrieves a run step including File Search result contents.

Parameters:

threadId - The ID of the thread to which the run and run step belongs.

runId - The ID of the run to which the run step belongs.

stepId - The ID of the run step to retrieve.

Returns:

The run step object matching the specified ID.