fix(client): fix verbosity parameter location in Responses

fixes error with unsupported `verbosity` parameter by correctly placing it inside the `text` parameter

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-56d3a72a5caa187aebcf9de169a6a28a9dc3f70a79d7467a03a9e22595936066.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-6a1bfd4738fff02ef5becc3fdb2bf0cd6c026f2c924d4147a2a515474477dd9a.yml
 openapi_spec_hash: 3eb8d86c06f0bb5e1190983e5acfc9ba
-config_hash: 7e18239879286d68a48ac5487a649aa6
+config_hash: a67c5e195a59855fe8a5db0dc61a3e7f

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

@@ -65,7 +65,6 @@ private constructor(
     private val truncation: JsonField<Truncation>,
     private val usage: JsonField<ResponseUsage>,
     private val user: JsonField<String>,
-    private val verbosity: JsonField<Verbosity>,
     private val additionalProperties: MutableMap<String, JsonValue>,
 ) {
 
@@ -138,9 +137,6 @@ private constructor(
         truncation: JsonField<Truncation> = JsonMissing.of(),
         @JsonProperty("usage") @ExcludeMissing usage: JsonField<ResponseUsage> = JsonMissing.of(),
         @JsonProperty("user") @ExcludeMissing user: JsonField<String> = JsonMissing.of(),
-        @JsonProperty("verbosity")
-        @ExcludeMissing
-        verbosity: JsonField<Verbosity> = JsonMissing.of(),
     ) : this(
         id,
         createdAt,
@@ -171,7 +167,6 @@ private constructor(
         truncation,
         usage,
         user,
-        verbosity,
         mutableMapOf(),
     )
 
@@ -492,16 +487,6 @@ private constructor(
      */
     @Deprecated("deprecated") fun user(): Optional<String> = user.getOptional("user")
 
-    /**
-     * Constrains the verbosity of the model's response. Lower values will result in more concise
-     * responses, while higher values will result in more verbose responses. Currently supported
-     * values are `low`, `medium`, and `high`.
-     *
-     * @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
-     *   server responded with an unexpected value).
-     */
-    fun verbosity(): Optional<Verbosity> = verbosity.getOptional("verbosity")
-
     /**
      * Returns the raw JSON value of [id].
      *
@@ -729,13 +714,6 @@ private constructor(
     @ExcludeMissing
     fun _user(): JsonField<String> = user
 
-    /**
-     * Returns the raw JSON value of [verbosity].
-     *
-     * Unlike [verbosity], this method doesn't throw if the JSON field has an unexpected type.
-     */
-    @JsonProperty("verbosity") @ExcludeMissing fun _verbosity(): JsonField<Verbosity> = verbosity
-
     @JsonAnySetter
     private fun putAdditionalProperty(key: String, value: JsonValue) {
         additionalProperties.put(key, value)
@@ -805,7 +783,6 @@ private constructor(
         private var truncation: JsonField<Truncation> = JsonMissing.of()
         private var usage: JsonField<ResponseUsage> = JsonMissing.of()
         private var user: JsonField<String> = JsonMissing.of()
-        private var verbosity: JsonField<Verbosity> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -839,7 +816,6 @@ private constructor(
             truncation = response.truncation
             usage = response.usage
             user = response.user
-            verbosity = response.verbosity
             additionalProperties = response.additionalProperties.toMutableMap()
         }
 
@@ -1641,25 +1617,6 @@ private constructor(
          */
         @Deprecated("deprecated") fun user(user: JsonField<String>) = apply { this.user = user }
 
-        /**
-         * Constrains the verbosity of the model's response. Lower values will result in more
-         * concise responses, while higher values will result in more verbose responses. Currently
-         * supported values are `low`, `medium`, and `high`.
-         */
-        fun verbosity(verbosity: Verbosity?) = verbosity(JsonField.ofNullable(verbosity))
-
-        /** Alias for calling [Builder.verbosity] with `verbosity.orElse(null)`. */
-        fun verbosity(verbosity: Optional<Verbosity>) = verbosity(verbosity.getOrNull())
-
-        /**
-         * Sets [Builder.verbosity] to an arbitrary JSON value.
-         *
-         * You should usually call [Builder.verbosity] with a well-typed [Verbosity] value instead.
-         * This method is primarily for setting the field to an undocumented or not yet supported
-         * value.
-         */
-        fun verbosity(verbosity: JsonField<Verbosity>) = apply { this.verbosity = verbosity }
-
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
             putAllAdditionalProperties(additionalProperties)
@@ -1734,7 +1691,6 @@ private constructor(
                 truncation,
                 usage,
                 user,
-                verbosity,
                 additionalProperties.toMutableMap(),
             )
     }
@@ -1779,7 +1735,6 @@ private constructor(
         truncation().ifPresent { it.validate() }
         usage().ifPresent { it.validate() }
         user()
-        verbosity().ifPresent { it.validate() }
         validated = true
     }
 
@@ -1826,8 +1781,7 @@ private constructor(
             (if (topLogprobs.asKnown().isPresent) 1 else 0) +
             (truncation.asKnown().getOrNull()?.validity() ?: 0) +
             (usage.asKnown().getOrNull()?.validity() ?: 0) +
-            (if (user.asKnown().isPresent) 1 else 0) +
-            (verbosity.asKnown().getOrNull()?.validity() ?: 0)
+            (if (user.asKnown().isPresent) 1 else 0)
 
     /** Details about why the response is incomplete. */
     class IncompleteDetails
@@ -3046,158 +3000,20 @@ private constructor(
         override fun toString() = value.toString()
     }
 
-    /**
-     * Constrains the verbosity of the model's response. Lower values will result in more concise
-     * responses, while higher values will result in more verbose responses. Currently supported
-     * values are `low`, `medium`, and `high`.
-     */
-    class Verbosity @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
-
-        /**
-         * Returns this class instance's raw value.
-         *
-         * This is usually only useful if this instance was deserialized from data that doesn't
-         * match any known member, and you want to know that value. For example, if the SDK is on an
-         * older version than the API, then the API may respond with new members that the SDK is
-         * unaware of.
-         */
-        @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value
-
-        companion object {
-
-            @JvmField val LOW = of("low")
-
-            @JvmField val MEDIUM = of("medium")
-
-            @JvmField val HIGH = of("high")
-
-            @JvmStatic fun of(value: String) = Verbosity(JsonField.of(value))
-        }
-
-        /** An enum containing [Verbosity]'s known values. */
-        enum class Known {
-            LOW,
-            MEDIUM,
-            HIGH,
-        }
-
-        /**
-         * An enum containing [Verbosity]'s known values, as well as an [_UNKNOWN] member.
-         *
-         * An instance of [Verbosity] can contain an unknown value in a couple of cases:
-         * - It was deserialized from data that doesn't match any known member. For example, if the
-         *   SDK is on an older version than the API, then the API may respond with new members that
-         *   the SDK is unaware of.
-         * - It was constructed with an arbitrary value using the [of] method.
-         */
-        enum class Value {
-            LOW,
-            MEDIUM,
-            HIGH,
-            /**
-             * An enum member indicating that [Verbosity] was instantiated with an unknown value.
-             */
-            _UNKNOWN,
-        }
-
-        /**
-         * Returns an enum member corresponding to this class instance's value, or [Value._UNKNOWN]
-         * if the class was instantiated with an unknown value.
-         *
-         * Use the [known] method instead if you're certain the value is always known or if you want
-         * to throw for the unknown case.
-         */
-        fun value(): Value =
-            when (this) {
-                LOW -> Value.LOW
-                MEDIUM -> Value.MEDIUM
-                HIGH -> Value.HIGH
-                else -> Value._UNKNOWN
-            }
-
-        /**
-         * Returns an enum member corresponding to this class instance's value.
-         *
-         * Use the [value] method instead if you're uncertain the value is always known and don't
-         * want to throw for the unknown case.
-         *
-         * @throws OpenAIInvalidDataException if this class instance's value is a not a known
-         *   member.
-         */
-        fun known(): Known =
-            when (this) {
-                LOW -> Known.LOW
-                MEDIUM -> Known.MEDIUM
-                HIGH -> Known.HIGH
-                else -> throw OpenAIInvalidDataException("Unknown Verbosity: $value")
-            }
-
-        /**
-         * Returns this class instance's primitive wire representation.
-         *
-         * This differs from the [toString] method because that method is primarily for debugging
-         * and generally doesn't throw.
-         *
-         * @throws OpenAIInvalidDataException if this class instance's value does not have the
-         *   expected primitive type.
-         */
-        fun asString(): String =
-            _value().asString().orElseThrow { OpenAIInvalidDataException("Value is not a String") }
-
-        private var validated: Boolean = false
-
-        fun validate(): Verbosity = apply {
-            if (validated) {
-                return@apply
-            }
-
-            known()
-            validated = true
-        }
-
-        fun isValid(): Boolean =
-            try {
-                validate()
-                true
-            } catch (e: OpenAIInvalidDataException) {
-                false
-            }
-
-        /**
-         * Returns a score indicating how many valid values are contained in this object
-         * recursively.
-         *
-         * Used for best match union deserialization.
-         */
-        @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1
-
-        override fun equals(other: Any?): Boolean {
-            if (this === other) {
-                return true
-            }
-
-            return /* spotless:off */ other is Verbosity && value == other.value /* spotless:on */
-        }
-
-        override fun hashCode() = value.hashCode()
-
-        override fun toString() = value.toString()
-    }
-
     override fun equals(other: Any?): Boolean {
         if (this === other) {
             return true
         }
 
-        return /* spotless:off */ other is Response && id == other.id && createdAt == other.createdAt && error == other.error && incompleteDetails == other.incompleteDetails && instructions == other.instructions && metadata == other.metadata && model == other.model && object_ == other.object_ && output == other.output && parallelToolCalls == other.parallelToolCalls && temperature == other.temperature && toolChoice == other.toolChoice && tools == other.tools && topP == other.topP && background == other.background && maxOutputTokens == other.maxOutputTokens && maxToolCalls == other.maxToolCalls && previousResponseId == other.previousResponseId && prompt == other.prompt && promptCacheKey == other.promptCacheKey && reasoning == other.reasoning && safetyIdentifier == other.safetyIdentifier && serviceTier == other.serviceTier && status == other.status && text == other.text && topLogprobs == other.topLogprobs && truncation == other.truncation && usage == other.usage && user == other.user && verbosity == other.verbosity && additionalProperties == other.additionalProperties /* spotless:on */
+        return /* spotless:off */ other is Response && id == other.id && createdAt == other.createdAt && error == other.error && incompleteDetails == other.incompleteDetails && instructions == other.instructions && metadata == other.metadata && model == other.model && object_ == other.object_ && output == other.output && parallelToolCalls == other.parallelToolCalls && temperature == other.temperature && toolChoice == other.toolChoice && tools == other.tools && topP == other.topP && background == other.background && maxOutputTokens == other.maxOutputTokens && maxToolCalls == other.maxToolCalls && previousResponseId == other.previousResponseId && prompt == other.prompt && promptCacheKey == other.promptCacheKey && reasoning == other.reasoning && safetyIdentifier == other.safetyIdentifier && serviceTier == other.serviceTier && status == other.status && text == other.text && topLogprobs == other.topLogprobs && truncation == other.truncation && usage == other.usage && user == other.user && additionalProperties == other.additionalProperties /* spotless:on */
     }
 
     /* spotless:off */
-    private val hashCode: Int by lazy { Objects.hash(id, createdAt, error, incompleteDetails, instructions, metadata, model, object_, output, parallelToolCalls, temperature, toolChoice, tools, topP, background, maxOutputTokens, maxToolCalls, previousResponseId, prompt, promptCacheKey, reasoning, safetyIdentifier, serviceTier, status, text, topLogprobs, truncation, usage, user, verbosity, additionalProperties) }
+    private val hashCode: Int by lazy { Objects.hash(id, createdAt, error, incompleteDetails, instructions, metadata, model, object_, output, parallelToolCalls, temperature, toolChoice, tools, topP, background, maxOutputTokens, maxToolCalls, previousResponseId, prompt, promptCacheKey, reasoning, safetyIdentifier, serviceTier, status, text, topLogprobs, truncation, usage, user, additionalProperties) }
     /* spotless:on */
 
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "Response{id=$id, createdAt=$createdAt, error=$error, incompleteDetails=$incompleteDetails, instructions=$instructions, metadata=$metadata, model=$model, object_=$object_, output=$output, parallelToolCalls=$parallelToolCalls, temperature=$temperature, toolChoice=$toolChoice, tools=$tools, topP=$topP, background=$background, maxOutputTokens=$maxOutputTokens, maxToolCalls=$maxToolCalls, previousResponseId=$previousResponseId, prompt=$prompt, promptCacheKey=$promptCacheKey, reasoning=$reasoning, safetyIdentifier=$safetyIdentifier, serviceTier=$serviceTier, status=$status, text=$text, topLogprobs=$topLogprobs, truncation=$truncation, usage=$usage, user=$user, verbosity=$verbosity, additionalProperties=$additionalProperties}"
+        "Response{id=$id, createdAt=$createdAt, error=$error, incompleteDetails=$incompleteDetails, instructions=$instructions, metadata=$metadata, model=$model, object_=$object_, output=$output, parallelToolCalls=$parallelToolCalls, temperature=$temperature, toolChoice=$toolChoice, tools=$tools, topP=$topP, background=$background, maxOutputTokens=$maxOutputTokens, maxToolCalls=$maxToolCalls, previousResponseId=$previousResponseId, prompt=$prompt, promptCacheKey=$promptCacheKey, reasoning=$reasoning, safetyIdentifier=$safetyIdentifier, serviceTier=$serviceTier, status=$status, text=$text, topLogprobs=$topLogprobs, truncation=$truncation, usage=$usage, user=$user, additionalProperties=$additionalProperties}"
 }