Constructor Detail

Method Detail

• body

   final ResponseCompactParams.Builder body(ResponseCompactParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • model

  • input

  • instructions

  • previousResponseId

• model

   final ResponseCompactParams.Builder model(ResponseCompactParams.Model model)

  Model ID used to generate the response, like gpt-5 or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

• model

   final ResponseCompactParams.Builder model(Optional<ResponseCompactParams.Model> model)

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

• model

   final ResponseCompactParams.Builder model(JsonField<ResponseCompactParams.Model> model)

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed Model value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final ResponseCompactParams.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed Model constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• input

   final ResponseCompactParams.Builder input(ResponseCompactParams.Input input)

  Text, image, or file inputs to the model, used to generate a response

• input

   final ResponseCompactParams.Builder input(Optional<ResponseCompactParams.Input> input)

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

• input

   final ResponseCompactParams.Builder input(JsonField<ResponseCompactParams.Input> input)

  Sets Builder.input to an arbitrary JSON value.

  You should usually call Builder.input with a well-typed Input value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• input

   final ResponseCompactParams.Builder input(String string)

  Alias for calling input with Input.ofString(string).

• inputOfResponseInputItems

   final ResponseCompactParams.Builder inputOfResponseInputItems(List<ResponseInputItem> responseInputItems)

  Alias for calling input with Input.ofResponseInputItems(responseInputItems).

• instructions

   final ResponseCompactParams.Builder instructions(String instructions)

  A system (or developer) message inserted into the model's context. When used along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

• instructions

   final ResponseCompactParams.Builder instructions(Optional<String> instructions)

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

• instructions

   final ResponseCompactParams.Builder instructions(JsonField<String> instructions)

  Sets Builder.instructions to an arbitrary JSON value.

  You should usually call Builder.instructions with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• previousResponseId

   final ResponseCompactParams.Builder previousResponseId(String previousResponseId)

  The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

• previousResponseId

   final ResponseCompactParams.Builder previousResponseId(Optional<String> previousResponseId)

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

• previousResponseId

   final ResponseCompactParams.Builder previousResponseId(JsonField<String> previousResponseId)

  Sets Builder.previousResponseId to an arbitrary JSON value.

  You should usually call Builder.previousResponseId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final ResponseCompactParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final ResponseCompactParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final ResponseCompactParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final ResponseCompactParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final ResponseCompactParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final ResponseCompactParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ResponseCompactParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ResponseCompactParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ResponseCompactParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ResponseCompactParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ResponseCompactParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ResponseCompactParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ResponseCompactParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ResponseCompactParams build()

  Returns an immutable instance of ResponseCompactParams.

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

  The following fields are required:

  .model()