Skip to content

CHANGELOG.md

Latest commit

 

History

History
1171 lines (630 loc) · 54.9 KB

CHANGELOG.md

File metadata and controls

1171 lines (630 loc) · 54.9 KB

Changelog

3.29.0 (2026-03-17)

Full Changelog: v3.28.0...v3.29.0

Features

  • api: 5.4 nano and mini model slugs (c4ebb48)
  • api: add in and nin values to comparison filter type (d060d44)

Chores

  • internal: tweak CI branches (6379626)

3.28.0 (2026-03-14)

Full Changelog: v3.27.0...v3.28.0

Features

  • api: add /v1/videos endpoint option to batch (7b2d67e)
  • api: add defer_loading field to function tools (6d4b683)
  • api: custom voices (d00b782)

⚠ BREAKING CHANGES

  • api: The voice param and resouce has changed from a string to a string | {id: string}. This is a breaking change for Go.

3.27.0 (2026-03-13)

Full Changelog: v3.26.0...v3.27.0

Features

  • api: add video character/edit/extend, remove Azure/webhook/polling/accumulator (20da043)
  • api: add video edits/extensions/character, remove Azure/webhook/polling helpers (fa9413f)
  • api: api update (c88c6c9)
  • api: sora api improvements: character api, video extensions/edits, higher resolution exports. (93f6779)

Chores

  • internal: codegen related update (d531232)
  • internal: codegen related update (1748c11)
  • internal: codegen related update (531ece1)
  • internal: codegen related update (ce9f435)

3.26.0 (2026-03-05)

Full Changelog: v3.25.0...v3.26.0

Features

  • api: The GA ComputerTool now uses the CompuerTool class. The 'computer_use_preview' tool is moved to ComputerUsePreview (347418b)

3.25.0 (2026-03-05)

Full Changelog: v3.24.0...v3.25.0

Features

  • api: gpt-5.4, tool search tool, and new computer tool (101826d)
  • api: remove Phase from input/output messages, PromptCacheKey from responses (961b8ca)

Bug Fixes

Chores

  • internal: codegen related update (ab733b9)
  • internal: codegen related update (23d1831)
  • internal: reduce warnings (2963312)

3.24.0 (2026-02-24)

Full Changelog: v3.23.0...v3.24.0

Features

Bug Fixes

Chores

  • internal: move custom custom json tags to api (0735303)
  • internal: refactor sse event parsing (45dc6bb)

3.24.0 (2026-02-24)

Full Changelog: v3.23.0...v3.24.0

Features

Bug Fixes

Chores

  • internal: move custom custom json tags to api (0735303)
  • internal: refactor sse event parsing (45dc6bb)

3.23.0 (2026-02-24)

Full Changelog: v3.22.1...v3.23.0

Features

  • api: add gpt-realtime-1.5 and gpt-audio-1.5 models to realtime session (9076e2f)

3.22.1 (2026-02-23)

Full Changelog: v3.22.0...v3.22.1

Bug Fixes

  • allow canceling a request while it is waiting to retry (54672cf)

Chores

  • update mock server docs (3ac84dd)

Documentation

  • api: add batch size limit to vector store file batch parameters (f751c40)
  • api: clarify safety_identifier max length in chat completions and responses (8257f9b)
  • api: enhance method docstrings across audio/chat/completion/skill/upload/video APIs (38b8f63)

3.22.0 (2026-02-13)

Full Changelog: v3.21.0...v3.22.0

Features

  • api: container network_policy and skills (8e5ea23)

Bug Fixes

  • encoder: correctly serialize NullStruct (a6cb49e)

Documentation

3.21.0 (2026-02-10)

Full Changelog: v3.20.0...v3.21.0

Features

  • api: support for images in batch api (e23aeb1)

3.20.0 (2026-02-10)

Full Changelog: v3.19.0...v3.20.0

Features

  • api: skills and hosted shell (9e191de)

3.19.0 (2026-02-09)

Full Changelog: v3.18.0...v3.19.0

Features

  • api: responses context_management (199f230)

3.18.0 (2026-02-05)

Full Changelog: v3.17.0...v3.18.0

Features

  • api: add shell_call_output status field (67a75d7)
  • api: image generation actions for responses; ResponseFunctionCallArgumentsDoneEvent.name (2c57016)

Bug Fixes

  • client: undo change to web search Find action (e340256)
  • client: update type for find_in_page action (4b5d499)

Chores

  • client: improve example values (c86a65c)

Documentation

  • split api.md by standalone resources (aeed37b)

3.17.0 (2026-01-27)

Full Changelog: v3.16.0...v3.17.0

Features

  • api: api update (a456c60)
  • api: api updates (21fd4a9)
  • client: add a convenient param.SetJSON helper (1b35ece)
  • client: add a StreamError type to access raw events from sse streams (fd14b30)

Bug Fixes

  • api: mark assistants as deprecated (9a8c9af)
  • client: retain streaming when user sets request body (3a7a22e)
  • docs: add missing pointer prefix to api.md return types (dd641d9)

Chores

  • internal: codegen related update (74d3989)
  • internal: update actions/checkout version (2db54a5)

3.16.0 (2026-01-09)

Full Changelog: v3.15.0...v3.16.0

Features

  • api: add new Response completed_at prop (bff6331)

Bug Fixes

  • client: use the correct order of params for vector store file and batch polling (ef32641)

Chores

  • internal: codegen related update (1e529a4)
  • internal: use different example values for some enums (a2836ee)

Documentation

3.15.0 (2025-12-19)

Full Changelog: v3.14.0...v3.15.0

Bug Fixes

Chores

  • add float64 to valid types for RegisterFieldValidator (e67d89d)

3.14.0 (2025-12-16)

Full Changelog: v3.13.0...v3.14.0

Features

3.13.0 (2025-12-15)

Full Changelog: v3.12.0...v3.13.0

Features

  • api: api update (20b5112)
  • api: fix grader input list, add dated slugs for sora-2 (e8f0b76)

Bug Fixes

  • azure: correct Azure OpenAI API URL construction and auth (3ba3736)

3.12.0 (2025-12-11)

Full Changelog: v3.11.0...v3.12.0

Features

  • api: gpt 5.2 (56b5d41)
  • encoder: support bracket encoding form-data object members (a2cbacf)

3.11.0 (2025-12-10)

Full Changelog: v3.10.0...v3.11.0

Features

  • api: make model required for the responses/compact endpoint (05f8f4d)

Bug Fixes

  • mcp: correct code tool API endpoint (03d08f9)
  • rename param to avoid collision (17d276d)

Chores

  • elide duplicate aliases (2bf988e)
  • internal: codegen related update (9b1a3e9)

3.10.0 (2025-12-04)

Full Changelog: v3.9.0...v3.10.0

Features

  • api: gpt-5.1-codex-max and responses/compact (1e1ca2a)

3.9.0 (2025-12-01)

Full Changelog: v3.8.1...v3.9.0

Features

Bug Fixes

  • api: align types of input items / output items for typescript (5b89d3b)
  • client: correctly specify Accept header with / instead of empty (fbadb4e)

Chores

3.8.1 (2025-11-04)

Full Changelog: v3.8.0...v3.8.1

Bug Fixes

  • api: fix nullability of logprobs (b5aeb99)

3.8.0 (2025-11-03)

Full Changelog: v3.7.0...v3.8.0

Features

  • api: Realtime API token_limits, Hybrid searching ranking options (9495f4a)

Chores

  • internal: grammar fix (it's -> its) (879772d)

3.7.0 (2025-10-28)

Full Changelog: v3.6.1...v3.7.0

Features

  • api: remove InputAudio from ResponseInputContent (cf50c53)
  • azure: allow passing custom scopes (#541) (dffa08e)

Bug Fixes

3.6.1 (2025-10-20)

Full Changelog: v3.6.0...v3.6.1

Bug Fixes

  • api: fix discriminator propertyName for ResponseFormatJsonSchema (57b0505)

3.6.0 (2025-10-20)

Full Changelog: v3.5.0...v3.6.0

Features

  • api: Add responses.input_tokens.count (a43f2ce)

Bug Fixes

  • api: internal openapi updates (7ad9b02)

3.5.0 (2025-10-17)

Full Changelog: v3.4.0...v3.5.0

Features

3.4.0 (2025-10-16)

Full Changelog: v3.3.0...v3.4.0

Features

  • api: Add support for gpt-4o-transcribe-diarize on audio/transcriptions endpoint (ee32400)

Chores

  • api: internal updates (74c8031)
  • client: undo more naming changes (db441bc)
  • client: undo some naming changes (a5aa3d6)

3.3.0 (2025-10-10)

Full Changelog: v3.2.0...v3.3.0

Features

  • api: comparison filter in/not in (d6daca0)

3.2.0 (2025-10-06)

Full Changelog: v3.1.0...v3.2.0

Features

  • api: dev day 2025 launches (d40a768)

3.1.0 (2025-10-02)

Full Changelog: v3.0.1...v3.1.0

Features

  • api: add support for realtime calls (565ca67)

3.0.1 (2025-10-01)

Full Changelog: v3.0.0...v3.0.1

Bug Fixes

  • api: add status, approval_request_id to MCP tool call (a7f95e4)

3.0.0 (2025-09-30)

Full Changelog: v2.7.1...v3.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 (21901ef)

2.7.1 (2025-09-29)

Full Changelog: v2.7.0...v2.7.1

Bug Fixes

  • bugfix for setting JSON keys with special characters (f9ae028)

2.7.0 (2025-09-23)

Full Changelog: v2.6.1...v2.7.0

Features

2.6.1 (2025-09-22)

Full Changelog: v2.6.0...v2.6.1

Bug Fixes

  • api: fix mcp tool name (6de601a)
  • use slices.Concat instead of sometimes modifying r.Options (7312ee7)

Chores

  • api: openapi updates for conversations (4a7d204)
  • bump minimum go version to 1.22 (8396ab5)
  • do not install brew dependencies in ./scripts/bootstrap by default (d519b81)
  • update more docs for 1.22 (1b0514d)

2.6.0 (2025-09-19)

Full Changelog: v2.5.0...v2.6.0

Features

  • api: add reasoning_text (6ebf50d)

2.5.0 (2025-09-17)

Full Changelog: v2.4.3...v2.5.0

Features

  • api: type updates for conversations, reasoning_effort and results for evals (3e68a60)

2.4.3 (2025-09-15)

Full Changelog: v2.4.2...v2.4.3

Chores

  • api: docs and spec refactoring (e67af66)

2.4.2 (2025-09-12)

Full Changelog: v2.4.1...v2.4.2

Chores

  • api: Minor docs and type updates for realtime (d92ea48)

2.4.1 (2025-09-10)

Full Changelog: v2.4.0...v2.4.1

Chores

  • api: fix realtime GA types (012b83e)

2.4.0 (2025-09-08)

Full Changelog: v2.3.1...v2.4.0

Features

  • api: ship the RealtimeGA API shape (2b6c6db)

2.3.1 (2025-09-05)

Full Changelog: v2.3.0...v2.3.1

Bug Fixes

  • internal: unmarshal correctly when there are multiple discriminators (98596b2)

2.3.0 (2025-09-03)

Full Changelog: v2.2.2...v2.3.0

Features

  • api: Add gpt-realtime models (3cf6a34)

2.2.2 (2025-09-02)

Full Changelog: v2.2.1...v2.2.2

Bug Fixes

  • update url to refresh pkg.go.dev (edf94ce)
  • use release please annotations on more places (2ff82f9)

2.2.1 (2025-09-02)

Full Changelog: v2.2.0...v2.2.1

Chores

  • api: manual updates for ResponseInputAudio (8c0ebe5)

2.2.0 (2025-09-02)

Full Changelog: v2.1.1...v2.2.0

Features

  • api: Add connectors support for MCP tool (35888bc)
  • api: add web search filters (6f2c71d)
  • api: adding support for /v1/conversations to the API (5b7c31b)
  • api: realtime API updates (130fc8e)
  • client: add support for verifying signatures on incoming webhooks (f7c8dbb)

Bug Fixes

  • azure: compatibility with edit image endpoint (#477) (d156eec)
  • close body before retrying (8dfed35)

Chores

  • internal/ci: setup breaking change detection (0af0cd0)
  • internal: version bump (3265795)

2.1.1 (2025-08-20)

Full Changelog: v2.1.0...v2.1.1

Chores

  • api: accurately represent shape for verbosity on Chat Completions (f81197b)

2.1.0 (2025-08-18)

Full Changelog: v2.0.2...v2.1.0

Features

  • api: add new text parameters, expiration options (323154c)

Documentation

  • give https its missing "h" in Azure OpenAI REST API link (#480) (8a401c9)

2.0.2 (2025-08-09)

Full Changelog: v2.0.1...v2.0.2

Chores

  • internal: update comment in script (4be24de)
  • update @stainless-api/prism-cli to v5.15.0 (eca22af)

2.0.1 (2025-08-08)

Full Changelog: v2.0.0...v2.0.1

Bug Fixes

  • client: fix verbosity parameter location in Responses (6e2e903)

2.0.0 (2025-08-07)

Full Changelog: v1.12.0...v2.0.0

Breaking changes

With the launch of custom tools in Chat Completions, function tools have been renamed to clarify the difference between the two.

ChatCompletionToolParam has become a union and is now named ChatCompletionToolUnionParam.

Older versions of the SDK used function tools: to migrate

- openai.ChatCompletionToolParam{
-  Function: openai.FunctionDefinitionParam{
+ openai.ChatCompletionFunctionTool(
+  openai.FunctionDefinitionParam{
    Name:        "get_weather",
    Description: openai.String("Get weather at the given location"),
    Parameters: openai.FunctionParameters{ … },
+  },
+ )
- },

Features

  • api: adds GPT-5 and new API features: platform.openai.com/docs/guides/gpt-5 (af46c88)
  • api: manual updates (219f209)
  • client: remove HTML escaping in JSON (aea5ebc)
  • client: rename union helpers (645e881)
  • client: support optional json html escaping (1d2336b)

Bug Fixes

  • client: revert path param changes (9239f06)

Chores

  • change readme warning and minimum version (1d0e22f)
  • document breaking changes (afaa2b8)
  • migrate examples (9c57dd7)

1.12.0 (2025-07-30)

Full Changelog: v1.11.1...v1.12.0

Features

Chores

  • client: refactor streaming slightly to better future proof it (0b9cb85)

1.11.1 (2025-07-22)

Full Changelog: v1.11.0...v1.11.1

Bug Fixes

  • client: process custom base url ahead of time (cc1c23e)

Chores

  • api: event shapes more accurate (2acd10d)

1.11.0 (2025-07-16)

Full Changelog: v1.10.3...v1.11.0

Features

1.10.3 (2025-07-15)

Full Changelog: v1.10.2...v1.10.3

1.10.2 (2025-07-15)

Full Changelog: v1.10.1...v1.10.2

Chores

  • api: update realtime specs, build config (3d2afda)

1.10.1 (2025-07-11)

Full Changelog: v1.10.0...v1.10.1

Chores

  • api: specification cleanup (5dbf6d2)
  • lint tests in subpackages (02f440d)

1.10.0 (2025-07-10)

Full Changelog: v1.9.0...v1.10.0

Features

  • api: add file_url, fix event ID (cb33971)

1.9.0 (2025-07-10)

Full Changelog: v1.8.3...v1.9.0

Features

  • client: expand max streaming buffer size (44390c8)

1.8.3 (2025-07-08)

Full Changelog: v1.8.2...v1.8.3

Chores

  • ci: only run for pushes and fork pull requests (d6aab99)
  • internal: fix lint script for tests (9c0a745)
  • lint tests (2bd38d2)

1.8.2 (2025-06-27)

Full Changelog: v1.8.1...v1.8.2

Bug Fixes

  • don't try to deserialize as json when ResponseBodyInto is []byte (74ad0f8)
  • pagination: check if page data is empty in GetNextPage (c9becdc)

1.8.1 (2025-06-26)

Full Changelog: v1.8.0...v1.8.1

Chores

  • api: remove unsupported property (e22316a)
  • docs: update README to include links to docs on Webhooks (7bb8f85)

1.8.0 (2025-06-26)

Full Changelog: v1.7.0...v1.8.0

Features

  • api: webhook and deep research support (f6a7e7d)

Chores

  • internal: add tests for breaking change detection (339522d)

1.7.0 (2025-06-23)

Full Changelog: v1.6.0...v1.7.0

Features

  • api: make model and inputs not required to create response (19f0b76)
  • api: update api shapes for usage and code interpreter (d24d42c)
  • client: add escape hatch for null slice & maps (9c633d6)

Chores

  • fix documentation of null map (8f3a134)

1.6.0 (2025-06-17)

Full Changelog: v1.5.0...v1.6.0

Features

  • api: add reusable prompt IDs (280c698)
  • api: manual updates (740f840)
  • client: add debug log helper (5715c49)

Chores

  • ci: enable for pull requests (9ed793a)

1.5.0 (2025-06-10)

Full Changelog: v1.4.0...v1.5.0

Features

  • api: Add o3-pro model IDs (3bbd0b8)

1.4.0 (2025-06-09)

Full Changelog: v1.3.0...v1.4.0

Features

  • client: allow overriding unions (27c6299)

Bug Fixes

  • client: cast to raw message when converting to params (a3282b0)

1.3.0 (2025-06-03)

Full Changelog: v1.2.1...v1.3.0

Features

  • api: add new realtime and audio models, realtime session options (8b8f62b)

1.2.1 (2025-06-02)

Full Changelog: v1.2.0...v1.2.1

Bug Fixes

  • api: Fix evals and code interpreter interfaces (7e244c7)
  • fix error (a200fca)

Chores

  • make go mod tidy continue on error (48f41c2)

1.2.0 (2025-05-29)

Full Changelog: v1.1.0...v1.2.0

Features

  • api: Config update for pakrym-stream-param (84d59d5)

Bug Fixes

  • client: return binary content from get /containers/{container_id}/files/{file_id}/content (f8c8de1)

Chores

  • deprecate Assistants API (027470e)
  • internal: fix release workflows (fd46533)

1.1.0 (2025-05-22)

Full Changelog: v1.0.0...v1.1.0

Features

  • api: add container endpoint (2bd777d)
  • api: new API tools (e7e2123)
  • api: new streaming helpers for background responses (422a0db)

Chores

  • docs: grammar improvements (f4b23dd)
  • improve devcontainer setup (dfdaeec)

1.0.0 (2025-05-19)

Full Changelog: v0.1.0-beta.11...v1.0.0

⚠ BREAKING CHANGES

  • client: rename file array param variant
  • api: improve naming and remove assistants
  • accumulator: update casing (#401)

Features

  • api: improve naming and remove assistants (4c623b8)

Bug Fixes

  • accumulator: update casing (#401) (d59453c)
  • client: correctly set stream key for multipart (0ec68f0)
  • client: don't panic on marshal with extra null field (9c15332)
  • client: increase max stream buffer size (9456455)
  • client: rename file array param variant (4cfcf86)
  • client: use scanner for streaming (aa58806)

Chores

0.1.0-beta.11 (2025-05-16)

Full Changelog: v0.1.0-beta.10...v0.1.0-beta.11

⚠ BREAKING CHANGES

  • client: clearer array variant names
  • client: rename resp package
  • client: improve core function names
  • client: improve union variant names
  • client: improve param subunions & deduplicate types

Features

  • api: add image sizes, reasoning encryption (0852fb3)
  • api: add o3 and o4-mini model IDs (3fabca6)
  • api: Add reinforcement fine-tuning api support (831a124)
  • api: adding gpt-4.1 family of model IDs (1ef19d4)
  • api: adding new image model support (bf17880)
  • api: manual updates (11f5716)
  • api: responses x eval api (183aaf7)
  • api: Updating Assistants and Evals API schemas (47ca619)
  • client: add dynamic streaming buffer to handle large lines (8e6aad6)
  • client: add helper method to generate constant structs (ff82809)
  • client: add support for endpoint-specific base URLs in python (072dce4)
  • client: add support for reading base URL from environment variable (0d37268)
  • client: clearer array variant names (a5d8b5d)
  • client: experimental support for unmarshalling into param structs (5234875)
  • client: improve param subunions & deduplicate types (8a78f37)
  • client: rename resp package (4433516)
  • client: support more time formats (ec171b2)
  • fix lint (9c50a1e)

Bug Fixes

  • client: clean up reader resources (710b92e)
  • client: correctly update body in WithJSONSet (f2d7118)
  • client: improve core function names (9f312a9)
  • client: improve union variant names (a2c3de9)
  • client: include path for type names in example code (69561c5)
  • client: resolve issue with optional multipart files (910d173)
  • client: time format encoding fix (ca17553)
  • client: unmarshal responses properly (fc9fec3)
  • handle empty bodies in WithJSONSet (8372464)
  • pagination: handle errors when applying options (eebf84b)

Chores

  • ci: add timeout thresholds for CI jobs (26b0dd7)
  • ci: only use depot for staging repos (7682154)
  • ci: run on more branches and use depot runners (d7badbc)
  • docs: document pre-request options (4befa5a)
  • docs: update respjson package name (9a00229)
  • readme: improve formatting (a847e8d)
  • utils: add internal resp to param utility (239c4e2)

Documentation

  • update documentation links to be more uniform (f5f0bb0)

0.1.0-beta.10 (2025-04-14)

Full Changelog: v0.1.0-beta.9...v0.1.0-beta.10

Chores

  • internal: expand CI branch coverage (#369) (258dda8)
  • internal: reduce CI branch coverage (a2f7c03)

0.1.0-beta.9 (2025-04-09)

Full Changelog: v0.1.0-beta.8...v0.1.0-beta.9

Chores

0.1.0-beta.8 (2025-04-09)

Full Changelog: v0.1.0-beta.7...v0.1.0-beta.8

Features

Chores

0.1.0-beta.7 (2025-04-07)

Full Changelog: v0.1.0-beta.6...v0.1.0-beta.7

Features

  • client: make response union's AsAny method type safe (#352) (1252f56)

Chores

0.1.0-beta.6 (2025-04-04)

Full Changelog: v0.1.0-beta.5...v0.1.0-beta.6

Features

  • api: manual updates (4e39609)
  • client: support unions in query and forms (#347) (cf8af37)

0.1.0-beta.5 (2025-04-03)

Full Changelog: v0.1.0-beta.4...v0.1.0-beta.5

Features

  • api: manual updates (563cc50)
  • client: omitzero on required id parameter (#339) (c0b4842)

Bug Fixes

  • client: return error on bad custom url instead of panic (#341) (a06c5e6)
  • client: support multipart encoding array formats (#342) (5993b28)
  • client: unmarshal stream events into fresh memory (#340) (52c3e08)

0.1.0-beta.4 (2025-04-02)

Full Changelog: v0.1.0-beta.3...v0.1.0-beta.4

Features

Chores

  • docs: update file uploads in README (#333) (471c452)
  • internal: codegen related update (#335) (48422dc)
  • Remove deprecated/unused remote spec feature (c5077a1)

0.1.0-beta.3 (2025-03-28)

Full Changelog: v0.1.0-beta.2...v0.1.0-beta.3

⚠ BREAKING CHANGES

  • client: add enums (#327)

Features

  • api: add get /chat/completions endpoint (e8ed116)
  • api: add get /responses/{response_id}/input_items endpoint (8870c26)

Bug Fixes

Chores

0.1.0-beta.2 (2025-03-22)

Full Changelog: v0.1.0-beta.1...v0.1.0-beta.2

Bug Fixes

  • client: elide fields in ToAssistantParam (#309) (1fcd837)

0.1.0-beta.1 (2025-03-22)

Full Changelog: v0.1.0-alpha.67...v0.1.0-beta.1

Chores

0.1.0-alpha.67 (2025-03-21)

Full Changelog: v0.1.0-alpha.66...v0.1.0-alpha.67

⚠ BREAKING CHANGES

  • api: migrate to v2

Features

  • api: migrate to v2 (9377508)
  • api: new models for TTS, STT, + new audio features for Realtime (#298) (48fa064)

Chores

Documentation