Skip to content

Commit 5d89bd2

Browse files
stainless-app[bot]TomerAberbach
stainless-app[bot]
and
TomerAberbach
authored
release: 0.40.1 (#373)
* fix(client): don't call `validate()` during deserialization if we don't have to (#372) * docs: document request IDs * docs: add comment on response header methods (#374) * release: 0.40.1 --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com> Co-authored-by: Tomer Aberbach <tomer@stainless.com>
1 parent 5762189 commit 5d89bd2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+993
-1096
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.0"
2+
".": "0.40.1"
33
}

‎CHANGELOG.md‎

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

3+
## 0.40.1 (2025-03-28)
4+
5+
Full Changelog: [v0.40.0...v0.40.1](https://github.com/openai/openai-java/compare/v0.40.0...v0.40.1)
6+
7+
### Bug Fixes
8+
9+
* **client:** don't call `validate()` during deserialization if we don't have to ([#372](https://github.com/openai/openai-java/issues/372)) ([1dae9bf](https://github.com/openai/openai-java/commit/1dae9bfe33d1cdd78bf47d47c62c1db0c4e5ca53))
10+
11+
12+
### Documentation
13+
14+
* add comment on response header methods ([#374](https://github.com/openai/openai-java/issues/374)) ([80bba20](https://github.com/openai/openai-java/commit/80bba200247fa7620cbd63a44f452c2ad3d83a87))
15+
* document request IDs ([3e2fec3](https://github.com/openai/openai-java/commit/3e2fec36597a15ab56960f4f40096dc779013cca))
16+
317
## 0.40.0 (2025-03-27)
418

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

‎README.md‎

Lines changed: 22 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.0)
13-
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.40.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.40.0)
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)
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.0).
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).
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.0")
32+
implementation("com.openai:openai-java:0.40.1")
3333
```
3434

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

@@ -490,6 +490,23 @@ import com.openai.models.chat.completions.ChatCompletion;
490490
ChatCompletion parsedChatCompletion = chatCompletion.parse();
491491
```
492492

493+
### Request IDs
494+
495+
> For more information on debugging requests, see [the API docs](https://platform.openai.com/docs/api-reference/debugging-requests).
496+
497+
When using raw responses, you can access the `x-request-id` response header using the `requestId()` method:
498+
499+
```java
500+
import com.openai.core.http.HttpResponseFor;
501+
import com.openai.models.chat.completions.ChatCompletion;
502+
import java.util.Optional;
503+
504+
HttpResponseFor<ChatCompletion> chatCompletion = client.chat().completions().withRawResponse().create(params);
505+
Optional<String> requestId = chatCompletion.requestId();
506+
```
507+
508+
This can be used to quickly log failing requests and report them back to OpenAI.
509+
493510
## Error handling
494511

495512
The SDK throws custom unchecked exception types:

‎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.0" // x-release-please-version
11+
version = "0.40.1" // x-release-please-version
1212
}
1313

1414
subprojects {

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import com.fasterxml.jackson.databind.JsonMappingException
1111
import com.fasterxml.jackson.databind.JsonNode
1212
import com.fasterxml.jackson.databind.deser.ContextualDeserializer
1313
import com.fasterxml.jackson.databind.deser.std.StdDeserializer
14+
import com.openai.errors.OpenAIInvalidDataException
1415
import kotlin.reflect.KClass
1516

1617
abstract class BaseDeserializer<T : Any>(type: KClass<T>) :
@@ -29,6 +30,13 @@ abstract class BaseDeserializer<T : Any>(type: KClass<T>) :
2930

3031
protected abstract fun ObjectCodec.deserialize(node: JsonNode): T
3132

33+
protected fun <T> ObjectCodec.deserialize(node: JsonNode, type: TypeReference<T>): T =
34+
try {
35+
readValue(treeAsTokens(node), type)
36+
} catch (e: Exception) {
37+
throw OpenAIInvalidDataException("Error deserializing", e)
38+
}
39+
3240
protected fun <T> ObjectCodec.tryDeserialize(
3341
node: JsonNode,
3442
type: TypeReference<T>,

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ interface HttpResponse : AutoCloseable {
1111

1212
fun headers(): Headers
1313

14+
/**
15+
* Returns the value of the `x-request-id` header, or an empty [Optional] if there's no such
16+
* header in the response.
17+
*/
1418
fun requestId(): Optional<String> =
1519
Optional.ofNullable(headers().values("x-request-id").firstOrNull())
1620

‎openai-java-core/src/main/kotlin/com/openai/models/audio/transcriptions/TranscriptionStreamEvent.kt‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -197,20 +197,18 @@ private constructor(
197197

198198
when (type) {
199199
"transcript.text.delta" -> {
200-
tryDeserialize(node, jacksonTypeRef<TranscriptionTextDeltaEvent>()) {
201-
it.validate()
202-
}
203-
?.let {
204-
return TranscriptionStreamEvent(transcriptTextDelta = it, _json = json)
205-
}
200+
return TranscriptionStreamEvent(
201+
transcriptTextDelta =
202+
deserialize(node, jacksonTypeRef<TranscriptionTextDeltaEvent>()),
203+
_json = json,
204+
)
206205
}
207206
"transcript.text.done" -> {
208-
tryDeserialize(node, jacksonTypeRef<TranscriptionTextDoneEvent>()) {
209-
it.validate()
210-
}
211-
?.let {
212-
return TranscriptionStreamEvent(transcriptTextDone = it, _json = json)
213-
}
207+
return TranscriptionStreamEvent(
208+
transcriptTextDone =
209+
deserialize(node, jacksonTypeRef<TranscriptionTextDoneEvent>()),
210+
_json = json,
211+
)
214212
}
215213
}
216214

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

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2511,26 +2511,16 @@ private constructor(
25112511

25122512
when (type) {
25132513
"auto" -> {
2514-
tryDeserialize(node, jacksonTypeRef<JsonValue>()) {
2515-
it.let {
2516-
if (it != JsonValue.from(mapOf("type" to "auto"))) {
2517-
throw OpenAIInvalidDataException(
2518-
"'auto' is invalid, received $it"
2519-
)
2520-
}
2521-
}
2522-
}
2523-
?.let {
2524-
return ChunkingStrategy(auto = it, _json = json)
2525-
}
2514+
return ChunkingStrategy(
2515+
auto = deserialize(node, jacksonTypeRef<JsonValue>()),
2516+
_json = json,
2517+
)
25262518
}
25272519
"static" -> {
2528-
tryDeserialize(node, jacksonTypeRef<StaticObject>()) {
2529-
it.validate()
2530-
}
2531-
?.let {
2532-
return ChunkingStrategy(static_ = it, _json = json)
2533-
}
2520+
return ChunkingStrategy(
2521+
static_ = deserialize(node, jacksonTypeRef<StaticObject>()),
2522+
_json = json,
2523+
)
25342524
}
25352525
}
25362526

0 commit comments

Comments
 (0)