Skip to content

Conversation

stainless-app[bot]
Copy link
Contributor

@stainless-app stainless-app bot commented Sep 30, 2025

Automated Release PR

4.0.0 (2025-09-30)

Full Changelog: v3.7.1...v4.0.0

⚠ BREAKING CHANGES

  • api: ResponseFunctionToolCallOutputItem.output and ResponseCustomToolCallOutput.output now return string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile> instead of string only. This may break existing callsites that assume output is always a string.

Features

  • api: Support images and files for function call outputs in responses, BatchUsage (de7a6c1)

Bug Fixes

  • client: remove duplicate outputAsJson function (4718871)

This pull request is managed by Stainless's GitHub App.

The semver version number is based on included commit messages. Alternatively, you can manually set the version number in the title of this pull request.

For a better experience, it is recommended to use either rebase-merge or squash-merge when merging this pull request.

🔗 Stainless website
📚 Read the docs
🙋 Reach out for help or questions

…onses, BatchUsage

This release introduces a major version change to reflect a breaking modification in the `ResponseFunctionToolCallOutputItem` and `ResponseCustomToolCallOutput` schemas. Specifically, the `output` field, which previously accepted only a `string` value, has been expanded to support multiple structured types:

```
Before:  output: string
After:   output: string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile>
```

This change allows custom tool calls to return images, files, and rich text content in addition to plain strings, aligning `ResponseCustomToolCallOutput` with the broader `ResponseInput` type system. Because this alters the type and shape of the field, it may break existing callsites that only accept strings.

BREAKING CHANGE: `ResponseFunctionToolCallOutputItem.output` and `ResponseCustomToolCallOutput.output` now return `string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile>` instead of `string` only. This may break existing callsites that assume `output` is always a string.
@stainless-app stainless-app bot requested a review from a team as a code owner September 30, 2025 07:37
@stainless-app stainless-app bot force-pushed the release-please--branches--main--changes--next branch from 039fb42 to 4c692df Compare September 30, 2025 16:53
@stainless-app stainless-app bot merged commit adfdf71 into main Sep 30, 2025
9 checks passed
Copy link
Contributor Author

stainless-app bot commented Sep 30, 2025

🤖 Release is at https://github.com/openai/openai-java/releases/tag/v4.0.0 🌻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants