Class ItemListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class ItemListParams implements Params
List all items for a conversation with the given ID.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classItemListParams.BuilderA builder for ItemListParams.
public final classItemListParams.OrderThe order to return the input items in. Default is
desc.asc: Return the input items in ascending order.desc: Return the input items in descending order.
-
Method Summary
Modifier and Type Method Description final Optional<String>conversationId()final Optional<String>after()An item ID to list items after, used in pagination. final Optional<List<ResponseIncludable>>include()Specify additional output data to include in the model response. final Optional<Long>limit()A limit on the number of objects to be returned. final Optional<ItemListParams.Order>order()The order to return the input items in. final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final ItemListParams.BuildertoBuilder()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ItemListParamsnone()final static ItemListParams.Builderbuilder()Returns a mutable builder for constructing an instance of ItemListParams. -
-
Method Detail
-
conversationId
final Optional<String> conversationId()
-
include
final Optional<List<ResponseIncludable>> include()
Specify additional output data to include in the model response. Currently supported values are:
web_search_call.action.sources: Include the sources of the web search tool call.code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items.computer_call_output.output.image_url: Include image urls from the computer call output.file_search_call.results: Include the search results of the file search tool call.message.input_image.image_url: Include image urls from the input message.message.output_text.logprobs: Include logprobs with assistant messages.reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when thestoreparameter is set tofalse, or when an organization is enrolled in the zero data retention program).
-
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<ItemListParams.Order> order()
The order to return the input items in. Default is
desc.asc: Return the input items in ascending order.desc: Return the input items in descending order.
-
_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 ItemListParams.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.
-
none
final static ItemListParams none()
-
builder
final static ItemListParams.Builder builder()
Returns a mutable builder for constructing an instance of ItemListParams.
-
-
-
-