Skip to content

Commit 25f6953

Browse files
stainless-app[bot]damomeorphis
authored
release: 0.38.0 (#360)
* feat(client): add chat completion streaming helper (#354) * chore(internal): remove CI condition (#310) * chore(internal): update release workflows * streaming-helpers: chat completion accumulator and docs. * streaming-helpers: minor improvements to comments. * streaming-helpers: added file lost in auto-merge/rebase with next branch. * streaming-helpers: changes to use of Optional.get(). * streaming-helpers: Resolved TODOs and added use of map() function. --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com> Co-authored-by: meorphis <eric@stainless.com> * chore: add hash of OpenAPI spec/config inputs to .stats.yml * chore(api): updates to supported Voice IDs (#361) * chore(internal): delete unused methods and annotations (#362) fix(client): map deserialization bug * release: 0.38.0 --------- Co-authored-by: D Gardner <damien@gardnersworld.org> Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com> Co-authored-by: meorphis <eric@stainless.com>
1 parent d6a3742 commit 25f6953

Some content is hidden

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

42 files changed

+1251
-464
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.37.0"
2+
".": "0.38.0"
33
}

‎.stats.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
configured_endpoints: 78
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-5ad6884898c07591750dde560118baf7074a59aecd1f367f930c5e42b04e848a.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-6663c59193eb95b201e492de17dcbd5e126ba03d18ce66287a3e2c632ca56fe7.yml
3+
openapi_spec_hash: 7996d2c34cc44fe2ce9ffe93c0ab774e
4+
config_hash: d36e491b0afc4f79e3afad4b3c9bec70

‎CHANGELOG.md‎

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

3+
## 0.38.0 (2025-03-27)
4+
5+
Full Changelog: [v0.37.0...v0.38.0](https://github.com/openai/openai-java/compare/v0.37.0...v0.38.0)
6+
7+
### Features
8+
9+
* **client:** add chat completion streaming helper ([#354](https://github.com/openai/openai-java/issues/354)) ([561c085](https://github.com/openai/openai-java/commit/561c0853b8a06814dba873e942629dff050b325d))
10+
11+
12+
### Bug Fixes
13+
14+
* **client:** map deserialization bug ([caa79a2](https://github.com/openai/openai-java/commit/caa79a267a79845eee3a49b22bcbe66849d9cf4e))
15+
16+
17+
### Chores
18+
19+
* add hash of OpenAPI spec/config inputs to .stats.yml ([d27646c](https://github.com/openai/openai-java/commit/d27646c179082f6bcba9b5df6b333134968adc95))
20+
* **api:** updates to supported Voice IDs ([#361](https://github.com/openai/openai-java/issues/361)) ([fd0d45a](https://github.com/openai/openai-java/commit/fd0d45a6f74e6571f1553231a69621db5720580f))
21+
* **internal:** delete unused methods and annotations ([#362](https://github.com/openai/openai-java/issues/362)) ([caa79a2](https://github.com/openai/openai-java/commit/caa79a267a79845eee3a49b22bcbe66849d9cf4e))
22+
323
## 0.37.0 (2025-03-25)
424

525
Full Changelog: [v0.36.0...v0.37.0](https://github.com/openai/openai-java/compare/v0.36.0...v0.37.0)

‎README.md‎

Lines changed: 57 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.37.0)
13-
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.37.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.37.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.38.0)
13+
[![javadoc](https://javadoc.io/badge2/com.openai/openai-java/0.38.0/javadoc.svg)](https://javadoc.io/doc/com.openai/openai-java/0.38.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.37.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.38.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.37.0")
32+
implementation("com.openai:openai-java:0.38.0")
3333
```
3434

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

@@ -288,6 +288,58 @@ OpenAIClient client = OpenAIOkHttpClient.builder()
288288
.build();
289289
```
290290

291+
### Streaming helpers
292+
293+
The SDK provides conveniences for streamed chat completions. A
294+
[`ChatCompletionAccumulator`](openai-java-core/src/main/kotlin/com/openai/helpers/ChatCompletionAccumulator.kt)
295+
can record the stream of chat completion chunks in the response as they are processed and accumulate
296+
a [`ChatCompletion`](openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletion.kt)
297+
object similar to that which would have been returned by the non-streaming API.
298+
299+
For a synchronous response add a
300+
[`Stream.peek()`](https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html#peek-java.util.function.Consumer-)
301+
call to the stream pipeline to accumulate each chunk:
302+
303+
```java
304+
import com.openai.core.http.StreamResponse;
305+
import com.openai.helpers.ChatCompletionAccumulator;
306+
import com.openai.models.chat.completions.ChatCompletion;
307+
import com.openai.models.chat.completions.ChatCompletionChunk;
308+
309+
ChatCompletionAccumulator chatCompletionAccumulator = ChatCompletionAccumulator.create();
310+
311+
try (StreamResponse<ChatCompletionChunk> streamResponse =
312+
client.chat().completions().createStreaming(createParams)) {
313+
streamResponse.stream()
314+
.peek(chatCompletionAccumulator::accumulate)
315+
.flatMap(completion -> completion.choices().stream())
316+
.flatMap(choice -> choice.delta().content().stream())
317+
.forEach(System.out::print);
318+
}
319+
320+
ChatCompletion chatCompletion = chatCompletionAccumulator.chatCompletion();
321+
```
322+
323+
For an asynchronous response, add the `ChatCompletionAccumulator` to the `subscribe()` call:
324+
325+
```java
326+
import com.openai.helpers.ChatCompletionAccumulator;
327+
import com.openai.models.chat.completions.ChatCompletion;
328+
329+
ChatCompletionAccumulator chatCompletionAccumulator = ChatCompletionAccumulator.create();
330+
331+
client.chat()
332+
.completions()
333+
.createStreaming(createParams)
334+
.subscribe(chunk -> chatCompletionAccumulator.accumulate(chunk).choices().stream()
335+
.flatMap(choice -> choice.delta().content().stream())
336+
.forEach(System.out::print))
337+
.onCompleteFuture()
338+
.join();
339+
340+
ChatCompletion chatCompletion = chatCompletionAccumulator.chatCompletion();
341+
```
342+
291343
## File uploads
292344

293345
The SDK defines methods that accept files.

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

1414
subprojects {

0 commit comments

Comments
 (0)