Constructor Detail

Method Detail

• conversationId

   final ItemListParams.Builder conversationId(String conversationId)

• conversationId

   final ItemListParams.Builder conversationId(Optional<String> conversationId)

  Alias for calling Builder.conversationId with conversationId.orElse(null).

• after

   final ItemListParams.Builder after(String after)

  An item ID to list items after, used in pagination.

• after

   final ItemListParams.Builder after(Optional<String> after)

  Alias for calling Builder.after with after.orElse(null).

• include

   final ItemListParams.Builder include(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 the store parameter is set to false, or when an organization is enrolled in the zero data retention program).

• include

   final ItemListParams.Builder include(Optional<List<ResponseIncludable>> include)

  Alias for calling Builder.include with include.orElse(null).

• addInclude

   final ItemListParams.Builder addInclude(ResponseIncludable include)

  Adds a single ResponseIncludable to Builder.include.

• limit

   final ItemListParams.Builder limit(Long limit)

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• limit

   final ItemListParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final ItemListParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• order

   final ItemListParams.Builder order(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.

• order

   final ItemListParams.Builder order(Optional<ItemListParams.Order> order)

  Alias for calling Builder.order with order.orElse(null).

• additionalHeaders

   final ItemListParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final ItemListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final ItemListParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final ItemListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final ItemListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final ItemListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final ItemListParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final ItemListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final ItemListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final ItemListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final ItemListParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final ItemListParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final ItemListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final ItemListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final ItemListParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final ItemListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final ItemListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final ItemListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final ItemListParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final ItemListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final ItemListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final ItemListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final ItemListParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final ItemListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final ItemListParams build()

  Returns an immutable instance of ItemListParams.

  Further updates to this Builder will not mutate the returned instance.