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


public final class InputItemListParams
 implements Params

Returns a list of input items for a given response.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`InputItemListParams.Builder`	A builder for InputItemListParams.
`public final class`	`InputItemListParams.Order`	The order to return the input items in. Default is `asc`. `asc`: Return the input items in ascending order. `desc`: Return the input items in descending order.

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`	`responseId()`
`final Optional<String>`	`after()`	An item ID to list items after, used in pagination.
`final Optional<String>`	`before()`	An item ID to list items before, used in pagination.
`final Optional<List<ResponseIncludable>>`	`include()`	Additional fields to include in the response.
`final Optional<Long>`	`limit()`	A limit on the number of objects to be returned.
`final Optional<InputItemListParams.Order>`	`order()`	The order to return the input items in.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final InputItemListParams.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 InputItemListParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of InputItemListParams.

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

- Constructor Detail
- Method Detail
  - responseId
```
 final String responseId()
```
  - after
```
 final Optional<String> after()
```
    An item ID to list items after, used in pagination.
  - before
```
 final Optional<String> before()
```
    An item ID to list items before, used in pagination.
  - include
```
 final Optional<List<ResponseIncludable>> include()
```
    Additional fields to include in the response. See the include parameter for Response creation above for more information.
  - limit
```
 final Optional<Long> limit()
```
    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
  - order
```
 final Optional<InputItemListParams.Order> order()
```
    The order to return the input items in. Default is asc.
    asc: Return the input items in ascending order.
    desc: Return the input items in descending order.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final InputItemListParams.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 InputItemListParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of InputItemListParams.
    The following fields are required:
    .responseId()

Class InputItemListParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

responseId

after

before

include

limit

order

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder