All Implemented Interfaces:: com.openai.core.Params

@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") 
public final class StepRetrieveParams
 implements Params

Retrieves a run step.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`StepRetrieveParams.Builder`	A builder for StepRetrieveParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`threadId()`
`final String`	`runId()`
`final Optional<String>`	`stepId()`
`final Optional<List<RunStepInclude>>`	`include()`	A list of additional fields to include in the response.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final StepRetrieveParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static StepRetrieveParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of StepRetrieveParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - threadId
```
 final String threadId()
```
  - runId
```
 final String runId()
```
  - stepId
```
 final Optional<String> stepId()
```
  - include
```
 final Optional<List<RunStepInclude>> include()
```
    A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.
    See the file search tool documentation for more information.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final StepRetrieveParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static StepRetrieveParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of StepRetrieveParams.
    The following fields are required:
    .threadId() .runId()

Class StepRetrieveParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

threadId

runId

stepId

include

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder