Skip to content

Commit c843c0f

Browse files
stainless-app[bot]stainless-app[bot]
authored
release: 0.41.0 (#378)
* fix(client): limit json deserialization coercion (#377) * feat(client): improve some method names (#379) * release: 0.41.0 --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
1 parent 5d89bd2 commit c843c0f

31 files changed

+268
-259
lines changed

‎.release-please-manifest.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.40.1"
2+
".": "0.41.0"
33
}

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Changelog
22

3+
## 0.41.0 (2025-03-31)
4+
5+
Full Changelog: [v0.40.1...v0.41.0](https://github.com/openai/openai-java/compare/v0.40.1...v0.41.0)
6+
7+
### Features
8+
9+
* **client:** improve some method names ([#379](https://github.com/openai/openai-java/issues/379)) ([895f99a](https://github.com/openai/openai-java/commit/895f99acaee6f8e38165c72da1de18e3d7682321))
10+
11+
12+
### Bug Fixes
13+
14+
* **client:** limit json deserialization coercion ([#377](https://github.com/openai/openai-java/issues/377)) ([5234cf9](https://github.com/openai/openai-java/commit/5234cf94a540191ae051e3123b7d1be088655100))
15+
316
## 0.40.1 (2025-03-28)
417

518
Full Changelog: [v0.40.0...v0.40.1](https://github.com/openai/openai-java/compare/v0.40.0...v0.40.1)

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@
99
1010
<!-- x-release-please-start-version -->
1111

12-
[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.40.1)
13-
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.40.1/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.40.1)
12+
[![Maven Central](https://img.shields.io/maven-central/v/com.openai/openai-java)](https://central.sonatype.com/artifact/com.openai/openai-java/0.41.0)
13+
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.41.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.41.0)
1414

1515
<!-- x-release-please-end -->
1616

1717
The OpenAI Java SDK provides convenient access to the [OpenAI REST API](https://platform.openai.com/docs) from applications written in Java.
1818

1919
<!-- x-release-please-start-version -->
2020

21-
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.40.1).
21+
The REST API documentation can be found on [platform.openai.com](https://platform.openai.com/docs). Javadocs are also available on [javadoc.io](https://javadoc.io/doc/com.openai/openai-java/0.41.0).
2222

2323
<!-- x-release-please-end -->
2424

@@ -29,7 +29,7 @@ The REST API documentation can be found on [platform.openai.com](https://platfor
2929
### Gradle
3030

3131
```kotlin
32-
implementation("com.openai:openai-java:0.40.1")
32+
implementation("com.openai:openai-java:0.41.0")
3333
```
3434

3535
### Maven
@@ -38,7 +38,7 @@ implementation("com.openai:openai-java:0.40.1")
3838
<dependency>
3939
<groupId>com.openai</groupId>
4040
<artifactId>openai-java</artifactId>
41-
<version>0.40.1</version>
41+
<version>0.41.0</version>
4242
</dependency>
4343
```
4444

‎build.gradle.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ repositories {
88

99
allprojects {
1010
group = "com.openai"
11-
version = "0.40.1" // x-release-please-version
11+
version = "0.41.0" // x-release-please-version
1212
}
1313

1414
subprojects {

‎openai-java-core/build.gradle.kts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ dependencies {
3434
testImplementation("org.assertj:assertj-core:3.25.3")
3535
testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.3")
3636
testImplementation("org.junit.jupiter:junit-jupiter-params:5.9.3")
37+
testImplementation("org.junit-pioneer:junit-pioneer:1.9.1")
3738
testImplementation("org.mockito:mockito-core:5.14.2")
3839
testImplementation("org.mockito:mockito-junit-jupiter:5.14.2")
3940
testImplementation("org.mockito.kotlin:mockito-kotlin:4.1.0")

‎openai-java-core/src/main/kotlin/com/openai/core/ObjectMappers.kt‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ import com.fasterxml.jackson.databind.DeserializationFeature
88
import com.fasterxml.jackson.databind.MapperFeature
99
import com.fasterxml.jackson.databind.SerializationFeature
1010
import com.fasterxml.jackson.databind.SerializerProvider
11+
import com.fasterxml.jackson.databind.cfg.CoercionAction
12+
import com.fasterxml.jackson.databind.cfg.CoercionInputShape
1113
import com.fasterxml.jackson.databind.json.JsonMapper
1214
import com.fasterxml.jackson.databind.module.SimpleModule
15+
import com.fasterxml.jackson.databind.type.LogicalType
1316
import com.fasterxml.jackson.datatype.jdk8.Jdk8Module
1417
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule
1518
import com.fasterxml.jackson.module.kotlin.kotlinModule
@@ -21,6 +24,60 @@ fun jsonMapper(): JsonMapper =
2124
.addModule(Jdk8Module())
2225
.addModule(JavaTimeModule())
2326
.addModule(SimpleModule().addSerializer(InputStreamJsonSerializer))
27+
.withCoercionConfig(LogicalType.Boolean) {
28+
it.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
29+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
30+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
31+
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
32+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
33+
}
34+
.withCoercionConfig(LogicalType.Integer) {
35+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
36+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
37+
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
38+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
39+
}
40+
.withCoercionConfig(LogicalType.Float) {
41+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
42+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
43+
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
44+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
45+
}
46+
.withCoercionConfig(LogicalType.Textual) {
47+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
48+
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
49+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
50+
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
51+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
52+
}
53+
.withCoercionConfig(LogicalType.Array) {
54+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
55+
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
56+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
57+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
58+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
59+
}
60+
.withCoercionConfig(LogicalType.Collection) {
61+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
62+
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
63+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
64+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
65+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
66+
}
67+
.withCoercionConfig(LogicalType.Map) {
68+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
69+
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
70+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
71+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
72+
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
73+
}
74+
.withCoercionConfig(LogicalType.POJO) {
75+
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
76+
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
77+
.setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
78+
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
79+
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
80+
}
2481
.serializationInclusion(JsonInclude.Include.NON_ABSENT)
2582
.disable(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE)
2683
.disable(SerializationFeature.FLUSH_AFTER_WRITE_VALUE)

‎openai-java-core/src/main/kotlin/com/openai/models/beta/assistants/Assistant.kt‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -601,10 +601,8 @@ private constructor(
601601
this.responseFormat = responseFormat
602602
}
603603

604-
/**
605-
* Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofJsonValue()`.
606-
*/
607-
fun responseFormatJsonValue() = responseFormat(AssistantResponseFormatOption.ofJsonValue())
604+
/** Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofAuto()`. */
605+
fun responseFormatAuto() = responseFormat(AssistantResponseFormatOption.ofAuto())
608606

609607
/**
610608
* Alias for calling [responseFormat] with

‎openai-java-core/src/main/kotlin/com/openai/models/beta/assistants/AssistantCreateParams.kt‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -446,10 +446,8 @@ private constructor(
446446
body.responseFormat(responseFormat)
447447
}
448448

449-
/**
450-
* Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofJsonValue()`.
451-
*/
452-
fun responseFormatJsonValue() = apply { body.responseFormatJsonValue() }
449+
/** Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofAuto()`. */
450+
fun responseFormatAuto() = apply { body.responseFormatAuto() }
453451

454452
/**
455453
* Alias for calling [responseFormat] with
@@ -1247,12 +1245,8 @@ private constructor(
12471245
this.responseFormat = responseFormat
12481246
}
12491247

1250-
/**
1251-
* Alias for calling [responseFormat] with
1252-
* `AssistantResponseFormatOption.ofJsonValue()`.
1253-
*/
1254-
fun responseFormatJsonValue() =
1255-
responseFormat(AssistantResponseFormatOption.ofJsonValue())
1248+
/** Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofAuto()`. */
1249+
fun responseFormatAuto() = responseFormat(AssistantResponseFormatOption.ofAuto())
12561250

12571251
/**
12581252
* Alias for calling [responseFormat] with

‎openai-java-core/src/main/kotlin/com/openai/models/beta/assistants/AssistantUpdateParams.kt‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -443,10 +443,8 @@ private constructor(
443443
body.responseFormat(responseFormat)
444444
}
445445

446-
/**
447-
* Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofJsonValue()`.
448-
*/
449-
fun responseFormatJsonValue() = apply { body.responseFormatJsonValue() }
446+
/** Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofAuto()`. */
447+
fun responseFormatAuto() = apply { body.responseFormatAuto() }
450448

451449
/**
452450
* Alias for calling [responseFormat] with
@@ -1244,12 +1242,8 @@ private constructor(
12441242
this.responseFormat = responseFormat
12451243
}
12461244

1247-
/**
1248-
* Alias for calling [responseFormat] with
1249-
* `AssistantResponseFormatOption.ofJsonValue()`.
1250-
*/
1251-
fun responseFormatJsonValue() =
1252-
responseFormat(AssistantResponseFormatOption.ofJsonValue())
1245+
/** Alias for calling [responseFormat] with `AssistantResponseFormatOption.ofAuto()`. */
1246+
fun responseFormatAuto() = responseFormat(AssistantResponseFormatOption.ofAuto())
12531247

12541248
/**
12551249
* Alias for calling [responseFormat] with

‎openai-java-core/src/main/kotlin/com/openai/models/beta/threads/AssistantResponseFormatOption.kt‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ import java.util.Optional
4444
@JsonSerialize(using = AssistantResponseFormatOption.Serializer::class)
4545
class AssistantResponseFormatOption
4646
private constructor(
47-
private val jsonValue: JsonValue? = null,
47+
private val auto: JsonValue? = null,
4848
private val responseFormatText: ResponseFormatText? = null,
4949
private val responseFormatJsonObject: ResponseFormatJsonObject? = null,
5050
private val responseFormatJsonSchema: ResponseFormatJsonSchema? = null,
5151
private val _json: JsonValue? = null,
5252
) {
5353

5454
/** `auto` is the default value */
55-
fun jsonValue(): Optional<JsonValue> = Optional.ofNullable(jsonValue)
55+
fun auto(): Optional<JsonValue> = Optional.ofNullable(auto)
5656

5757
/** Default response format. Used to generate text responses. */
5858
fun responseFormatText(): Optional<ResponseFormatText> = Optional.ofNullable(responseFormatText)
@@ -72,7 +72,7 @@ private constructor(
7272
fun responseFormatJsonSchema(): Optional<ResponseFormatJsonSchema> =
7373
Optional.ofNullable(responseFormatJsonSchema)
7474

75-
fun isJsonValue(): Boolean = jsonValue != null
75+
fun isAuto(): Boolean = auto != null
7676

7777
fun isResponseFormatText(): Boolean = responseFormatText != null
7878

@@ -81,7 +81,7 @@ private constructor(
8181
fun isResponseFormatJsonSchema(): Boolean = responseFormatJsonSchema != null
8282

8383
/** `auto` is the default value */
84-
fun asJsonValue(): JsonValue = jsonValue.getOrThrow("jsonValue")
84+
fun asAuto(): JsonValue = auto.getOrThrow("auto")
8585

8686
/** Default response format. Used to generate text responses. */
8787
fun asResponseFormatText(): ResponseFormatText =
@@ -106,7 +106,7 @@ private constructor(
106106

107107
fun <T> accept(visitor: Visitor<T>): T {
108108
return when {
109-
jsonValue != null -> visitor.visitJsonValue(jsonValue)
109+
auto != null -> visitor.visitAuto(auto)
110110
responseFormatText != null -> visitor.visitResponseFormatText(responseFormatText)
111111
responseFormatJsonObject != null ->
112112
visitor.visitResponseFormatJsonObject(responseFormatJsonObject)
@@ -125,10 +125,10 @@ private constructor(
125125

126126
accept(
127127
object : Visitor<Unit> {
128-
override fun visitJsonValue(jsonValue: JsonValue) {
129-
jsonValue.let {
128+
override fun visitAuto(auto: JsonValue) {
129+
auto.let {
130130
if (it != JsonValue.from("auto")) {
131-
throw OpenAIInvalidDataException("'jsonValue' is invalid, received $it")
131+
throw OpenAIInvalidDataException("'auto' is invalid, received $it")
132132
}
133133
}
134134
}
@@ -158,14 +158,14 @@ private constructor(
158158
return true
159159
}
160160

161-
return /* spotless:off */ other is AssistantResponseFormatOption && jsonValue == other.jsonValue && responseFormatText == other.responseFormatText && responseFormatJsonObject == other.responseFormatJsonObject && responseFormatJsonSchema == other.responseFormatJsonSchema /* spotless:on */
161+
return /* spotless:off */ other is AssistantResponseFormatOption && auto == other.auto && responseFormatText == other.responseFormatText && responseFormatJsonObject == other.responseFormatJsonObject && responseFormatJsonSchema == other.responseFormatJsonSchema /* spotless:on */
162162
}
163163

164-
override fun hashCode(): Int = /* spotless:off */ Objects.hash(jsonValue, responseFormatText, responseFormatJsonObject, responseFormatJsonSchema) /* spotless:on */
164+
override fun hashCode(): Int = /* spotless:off */ Objects.hash(auto, responseFormatText, responseFormatJsonObject, responseFormatJsonSchema) /* spotless:on */
165165

166166
override fun toString(): String =
167167
when {
168-
jsonValue != null -> "AssistantResponseFormatOption{jsonValue=$jsonValue}"
168+
auto != null -> "AssistantResponseFormatOption{auto=$auto}"
169169
responseFormatText != null ->
170170
"AssistantResponseFormatOption{responseFormatText=$responseFormatText}"
171171
responseFormatJsonObject != null ->
@@ -179,8 +179,7 @@ private constructor(
179179
companion object {
180180

181181
/** `auto` is the default value */
182-
@JvmStatic
183-
fun ofJsonValue() = AssistantResponseFormatOption(jsonValue = JsonValue.from("auto"))
182+
@JvmStatic fun ofAuto() = AssistantResponseFormatOption(auto = JsonValue.from("auto"))
184183

185184
/** Default response format. Used to generate text responses. */
186185
@JvmStatic
@@ -212,7 +211,7 @@ private constructor(
212211
interface Visitor<out T> {
213212

214213
/** `auto` is the default value */
215-
fun visitJsonValue(jsonValue: JsonValue): T
214+
fun visitAuto(auto: JsonValue): T
216215

217216
/** Default response format. Used to generate text responses. */
218217
fun visitResponseFormatText(responseFormatText: ResponseFormatText): T
@@ -254,12 +253,12 @@ private constructor(
254253
tryDeserialize(node, jacksonTypeRef<JsonValue>()) {
255254
it.let {
256255
if (it != JsonValue.from("auto")) {
257-
throw OpenAIInvalidDataException("'jsonValue' is invalid, received $it")
256+
throw OpenAIInvalidDataException("'auto' is invalid, received $it")
258257
}
259258
}
260259
}
261260
?.let {
262-
return AssistantResponseFormatOption(jsonValue = it, _json = json)
261+
return AssistantResponseFormatOption(auto = it, _json = json)
263262
}
264263
tryDeserialize(node, jacksonTypeRef<ResponseFormatText>()) { it.validate() }
265264
?.let {
@@ -293,7 +292,7 @@ private constructor(
293292
provider: SerializerProvider,
294293
) {
295294
when {
296-
value.jsonValue != null -> generator.writeObject(value.jsonValue)
295+
value.auto != null -> generator.writeObject(value.auto)
297296
value.responseFormatText != null -> generator.writeObject(value.responseFormatText)
298297
value.responseFormatJsonObject != null ->
299298
generator.writeObject(value.responseFormatJsonObject)

0 commit comments

Comments
 (0)