feat(api): add image sizes, reasoning encryption

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 95
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-8b68ae6b807dca92e914da1dd9e835a20f69b075e79102a264367fd7fddddb33.yml
-openapi_spec_hash: b6ade5b1a6327339e6669e1134de2d03
-config_hash: b597cd9a31e9e5ec709e2eefb4c54122
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-0ee6b36cf3cc278cef4199a6aec5f7d530a6c1f17a74830037e96d50ca1edc50.yml
+openapi_spec_hash: e8ec5f46bc0655b34f292422d58a60f6
+config_hash: d9b6b6e6bc85744663e300eebc482067

openai-java-core/src/main/kotlin/com/openai/models/audio/speech/SpeechCreateParams.kt

@@ -76,6 +76,7 @@ private constructor(
 
     /**
      * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.
+     * Does not work with `gpt-4o-mini-tts`.
      *
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -271,7 +272,7 @@ private constructor(
 
         /**
          * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the
-         * default.
+         * default. Does not work with `gpt-4o-mini-tts`.
          */
         fun speed(speed: Double) = apply { body.speed(speed) }
 
@@ -502,7 +503,7 @@ private constructor(
 
         /**
          * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the
-         * default.
+         * default. Does not work with `gpt-4o-mini-tts`.
          *
          * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
          *   server responded with an unexpected value).
@@ -705,7 +706,7 @@ private constructor(
 
             /**
              * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the
-             * default.
+             * default. Does not work with `gpt-4o-mini-tts`.
              */
             fun speed(speed: Double) = speed(JsonField.of(speed))
 

openai-java-core/src/main/kotlin/com/openai/models/images/ImageEditParams.kt

@@ -23,8 +23,8 @@ import kotlin.jvm.optionals.getOrNull
  */
 class ComputerTool
 private constructor(
-    private val displayHeight: JsonField<Double>,
-    private val displayWidth: JsonField<Double>,
+    private val displayHeight: JsonField<Long>,
+    private val displayWidth: JsonField<Long>,
     private val environment: JsonField<Environment>,
     private val type: JsonValue,
     private val additionalProperties: MutableMap<String, JsonValue>,
@@ -34,10 +34,10 @@ private constructor(
     private constructor(
         @JsonProperty("display_height")
         @ExcludeMissing
-        displayHeight: JsonField<Double> = JsonMissing.of(),
+        displayHeight: JsonField<Long> = JsonMissing.of(),
         @JsonProperty("display_width")
         @ExcludeMissing
-        displayWidth: JsonField<Double> = JsonMissing.of(),
+        displayWidth: JsonField<Long> = JsonMissing.of(),
         @JsonProperty("environment")
         @ExcludeMissing
         environment: JsonField<Environment> = JsonMissing.of(),
@@ -50,15 +50,15 @@ private constructor(
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
-    fun displayHeight(): Double = displayHeight.getRequired("display_height")
+    fun displayHeight(): Long = displayHeight.getRequired("display_height")
 
     /**
      * The width of the computer display.
      *
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
-    fun displayWidth(): Double = displayWidth.getRequired("display_width")
+    fun displayWidth(): Long = displayWidth.getRequired("display_width")
 
     /**
      * The type of computer environment to control.
@@ -88,7 +88,7 @@ private constructor(
      */
     @JsonProperty("display_height")
     @ExcludeMissing
-    fun _displayHeight(): JsonField<Double> = displayHeight
+    fun _displayHeight(): JsonField<Long> = displayHeight
 
     /**
      * Returns the raw JSON value of [displayWidth].
@@ -97,7 +97,7 @@ private constructor(
      */
     @JsonProperty("display_width")
     @ExcludeMissing
-    fun _displayWidth(): JsonField<Double> = displayWidth
+    fun _displayWidth(): JsonField<Long> = displayWidth
 
     /**
      * Returns the raw JSON value of [environment].
@@ -138,8 +138,8 @@ private constructor(
     /** A builder for [ComputerTool]. */
     class Builder internal constructor() {
 
-        private var displayHeight: JsonField<Double>? = null
-        private var displayWidth: JsonField<Double>? = null
+        private var displayHeight: JsonField<Long>? = null
+        private var displayWidth: JsonField<Long>? = null
         private var environment: JsonField<Environment>? = null
         private var type: JsonValue = JsonValue.from("computer_use_preview")
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
@@ -154,32 +154,30 @@ private constructor(
         }
 
         /** The height of the computer display. */
-        fun displayHeight(displayHeight: Double) = displayHeight(JsonField.of(displayHeight))
+        fun displayHeight(displayHeight: Long) = displayHeight(JsonField.of(displayHeight))
 
         /**
          * Sets [Builder.displayHeight] to an arbitrary JSON value.
          *
-         * You should usually call [Builder.displayHeight] with a well-typed [Double] value instead.
+         * You should usually call [Builder.displayHeight] with a well-typed [Long] value instead.
          * This method is primarily for setting the field to an undocumented or not yet supported
          * value.
          */
-        fun displayHeight(displayHeight: JsonField<Double>) = apply {
+        fun displayHeight(displayHeight: JsonField<Long>) = apply {
             this.displayHeight = displayHeight
         }
 
         /** The width of the computer display. */
-        fun displayWidth(displayWidth: Double) = displayWidth(JsonField.of(displayWidth))
+        fun displayWidth(displayWidth: Long) = displayWidth(JsonField.of(displayWidth))
 
         /**
          * Sets [Builder.displayWidth] to an arbitrary JSON value.
          *
-         * You should usually call [Builder.displayWidth] with a well-typed [Double] value instead.
+         * You should usually call [Builder.displayWidth] with a well-typed [Long] value instead.
          * This method is primarily for setting the field to an undocumented or not yet supported
          * value.
          */
-        fun displayWidth(displayWidth: JsonField<Double>) = apply {
-            this.displayWidth = displayWidth
-        }
+        fun displayWidth(displayWidth: JsonField<Long>) = apply { this.displayWidth = displayWidth }
 
         /** The type of computer environment to control. */
         fun environment(environment: Environment) = environment(JsonField.of(environment))
@@ -306,9 +304,11 @@ private constructor(
 
         companion object {
 
+            @JvmField val WINDOWS = of("windows")
+
             @JvmField val MAC = of("mac")
 
-            @JvmField val WINDOWS = of("windows")
+            @JvmField val LINUX = of("linux")
 
             @JvmField val UBUNTU = of("ubuntu")
 
@@ -319,8 +319,9 @@ private constructor(
 
         /** An enum containing [Environment]'s known values. */
         enum class Known {
-            MAC,
             WINDOWS,
+            MAC,
+            LINUX,
             UBUNTU,
             BROWSER,
         }
@@ -335,8 +336,9 @@ private constructor(
          * - It was constructed with an arbitrary value using the [of] method.
          */
         enum class Value {
-            MAC,
             WINDOWS,
+            MAC,
+            LINUX,
             UBUNTU,
             BROWSER,
             /**
@@ -354,8 +356,9 @@ private constructor(
          */
         fun value(): Value =
             when (this) {
-                MAC -> Value.MAC
                 WINDOWS -> Value.WINDOWS
+                MAC -> Value.MAC
+                LINUX -> Value.LINUX
                 UBUNTU -> Value.UBUNTU
                 BROWSER -> Value.BROWSER
                 else -> Value._UNKNOWN
@@ -372,8 +375,9 @@ private constructor(
          */
         fun known(): Known =
             when (this) {
-                MAC -> Known.MAC
                 WINDOWS -> Known.WINDOWS
+                MAC -> Known.MAC
+                LINUX -> Known.LINUX
                 UBUNTU -> Known.UBUNTU
                 BROWSER -> Known.BROWSER
                 else -> throw OpenAIInvalidDataException("Unknown Environment: $value")

openai-java-core/src/main/kotlin/com/openai/models/responses/ComputerTool.kt

@@ -84,7 +84,7 @@ private constructor(
     fun vectorStoreIds(): List<String> = vectorStoreIds.getRequired("vector_store_ids")
 
     /**
-     * A filter to apply based on file attributes.
+     * A filter to apply.
      *
      * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -227,8 +227,11 @@ private constructor(
                 }
         }
 
-        /** A filter to apply based on file attributes. */
-        fun filters(filters: Filters) = filters(JsonField.of(filters))
+        /** A filter to apply. */
+        fun filters(filters: Filters?) = filters(JsonField.ofNullable(filters))
+
+        /** Alias for calling [Builder.filters] with `filters.orElse(null)`. */
+        fun filters(filters: Optional<Filters>) = filters(filters.getOrNull())
 
         /**
          * Sets [Builder.filters] to an arbitrary JSON value.
@@ -360,7 +363,7 @@ private constructor(
             (if (maxNumResults.asKnown().isPresent) 1 else 0) +
             (rankingOptions.asKnown().getOrNull()?.validity() ?: 0)
 
-    /** A filter to apply based on file attributes. */
+    /** A filter to apply. */
     @JsonDeserialize(using = Filters.Deserializer::class)
     @JsonSerialize(using = Filters.Serializer::class)
     class Filters

openai-java-core/src/main/kotlin/com/openai/models/responses/FileSearchTool.kt

@@ -56,18 +56,18 @@ private constructor(
     /**
      * A JSON schema object describing the parameters of the function.
      *
-     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
-     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
+     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
      */
-    fun parameters(): Parameters = parameters.getRequired("parameters")
+    fun parameters(): Optional<Parameters> = parameters.getOptional("parameters")
 
     /**
      * Whether to enforce strict parameter validation. Default `true`.
      *
-     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type or is
-     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
+     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
      */
-    fun strict(): Boolean = strict.getRequired("strict")
+    fun strict(): Optional<Boolean> = strict.getOptional("strict")
 
     /**
      * The type of the function tool. Always `function`.
@@ -180,7 +180,10 @@ private constructor(
         fun name(name: JsonField<String>) = apply { this.name = name }
 
         /** A JSON schema object describing the parameters of the function. */
-        fun parameters(parameters: Parameters) = parameters(JsonField.of(parameters))
+        fun parameters(parameters: Parameters?) = parameters(JsonField.ofNullable(parameters))
+
+        /** Alias for calling [Builder.parameters] with `parameters.orElse(null)`. */
+        fun parameters(parameters: Optional<Parameters>) = parameters(parameters.getOrNull())
 
         /**
          * Sets [Builder.parameters] to an arbitrary JSON value.
@@ -192,7 +195,17 @@ private constructor(
         fun parameters(parameters: JsonField<Parameters>) = apply { this.parameters = parameters }
 
         /** Whether to enforce strict parameter validation. Default `true`. */
-        fun strict(strict: Boolean) = strict(JsonField.of(strict))
+        fun strict(strict: Boolean?) = strict(JsonField.ofNullable(strict))
+
+        /**
+         * Alias for [Builder.strict].
+         *
+         * This unboxed primitive overload exists for backwards compatibility.
+         */
+        fun strict(strict: Boolean) = strict(strict as Boolean?)
+
+        /** Alias for calling [Builder.strict] with `strict.orElse(null)`. */
+        fun strict(strict: Optional<Boolean>) = strict(strict.getOrNull())
 
         /**
          * Sets [Builder.strict] to an arbitrary JSON value.
@@ -286,7 +299,7 @@ private constructor(
         }
 
         name()
-        parameters().validate()
+        parameters().ifPresent { it.validate() }
         strict()
         _type().let {
             if (it != JsonValue.from("function")) {

openai-java-core/src/main/kotlin/com/openai/models/responses/FunctionTool.kt

@@ -985,13 +985,13 @@ private constructor(
         /** Alias for calling [addTool] with `Tool.ofFunction(function)`. */
         fun addTool(function: FunctionTool) = addTool(Tool.ofFunction(function))
 
+        /** Alias for calling [addTool] with `Tool.ofWebSearch(webSearch)`. */
+        fun addTool(webSearch: WebSearchTool) = addTool(Tool.ofWebSearch(webSearch))
+
         /** Alias for calling [addTool] with `Tool.ofComputerUsePreview(computerUsePreview)`. */
         fun addTool(computerUsePreview: ComputerTool) =
             addTool(Tool.ofComputerUsePreview(computerUsePreview))
 
-        /** Alias for calling [addTool] with `Tool.ofWebSearch(webSearch)`. */
-        fun addTool(webSearch: WebSearchTool) = addTool(Tool.ofWebSearch(webSearch))
-
         /**
          * An alternative to sampling with temperature, called nucleus sampling, where the model
          * considers the results of the tokens with top_p probability mass. So 0.1 means only the