⬆️ Update dependency openai to v4

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
openai	^3.3.0 -> ^4.28.0

---

Release Notes

openai/openai-node (openai)

v4.28.0

Compare Source

Full Changelog: v4.27.1...v4.28.0

Features

• api: updates (#​669) (e1900f9)

v4.27.1

Compare Source

Full Changelog: v4.27.0...v4.27.1

v4.27.0

Compare Source

Full Changelog: v4.26.1...v4.27.0

Features

• api: add timestamp_granularities, add gpt-3.5-turbo-0125 model (#​661) (5016806)

Chores

• internal: fix retry mechanism for ecosystem-test (#​663) (0eb7ed5)
• respect application/vnd.api+json content-type header (#​664) (f4fad54)

v4.26.1

Compare Source

Full Changelog: v4.26.0...v4.26.1

Chores

• internal: enable building when git installed (#​657) (8c80a7d)
• internal: re-order pagination import (#​656) (21ae54e)
• internal: support pre-release versioning (#​653) (0c3859f)
• test: add delay between ecosystem tests retry (#​651) (6a4cc5c)

Documentation

• add a CONTRIBUTING.md (#​659) (8ea58b0)

v4.26.0

Compare Source

Full Changelog: v4.25.0...v4.26.0

Features

• api: add text embeddings dimensions param (#​650) (1b5a977)

Chores

• internal: add internal helpers & improve build scripts (#​643) (9392f50)
• internal: adjust ecosystem-tests logging in CI (#​646) (156084b)
• internal: don't re-export streaming type (#​648) (4c4be94)
• internal: fix binary files (#​645) (e1fbc39)
• internal: minor streaming updates (#​647) (2f073e4)
• internal: pin deno version (#​649) (7e4b903)

v4.25.0

Compare Source

Full Changelog: v4.24.7...v4.25.0

Features

• api: add usage to runs and run steps (#​640) (3caa416)

Bug Fixes

• allow body type in RequestOptions to be null (#​637) (c4f8a36)
• handle system_fingerprint in streaming helpers (#​636) (f273530)
• types: accept undefined for optional client options (#​635) (e48cd57)

Chores

• internal: debug logging for retries; speculative retry-after-ms support (#​633) (fd64971)
• internal: update comment (#​631) (e109d40)

v4.24.7

Compare Source

Full Changelog: v4.24.6...v4.24.7

Chores

• ecosystem-tests: fix flaky vercel-edge, cloudflare-worker, and deno tests (#​626) (ae412a5)
• ecosystem-tests: fix typo in deno test (#​628) (048ec94)

v4.24.6

Compare Source

Full Changelog: v4.24.5...v4.24.6

Chores

• ecosystem-tests: fix flaky tests and remove fine tuning calls (#​623) (258d79f)
• ecosystem-tests: fix flaky tests and remove fine tuning calls (#​625) (58e5fd8)

v4.24.5

Compare Source

Full Changelog: v4.24.4...v4.24.5

Refactors

• api: remove deprecated endpoints (#​621) (2054d71)

v4.24.4

Compare Source

Full Changelog: v4.24.3...v4.24.4

Chores

• internal: narrow type into stringifyQuery (#​619) (88fb9cd)

v4.24.3

Compare Source

Full Changelog: v4.24.2...v4.24.3

Bug Fixes

• use default base url if BASE_URL env var is blank (#​615) (a27ad3d)

v4.24.2

Compare Source

Full Changelog: v4.24.1...v4.24.2

Bug Fixes

• headers: always send lowercase headers and strip undefined (BREAKING in rare cases) (#​608) (4ea159f)

Chores

• add .keep files for examples and custom code directories (#​612) (5e0f733)
• internal: bump license (#​605) (045ee74)
• internal: improve type signatures (#​609) (e1ccc82)

Documentation

• fix docstring typos (#​600) (1934fa1)
• improve audio example to show how to stream to a file (#​598) (e950ad9)

v4.24.1

Compare Source

Full Changelog: v4.24.0...v4.24.1

Bug Fixes

• pagination: correct type annotation object field (#​590) (4066eda)

Documentation

• messages: improvements to helpers reference + typos (#​595) (96a59b9)
• reformat README.md (#​592) (8ffc7f8)

Refactors

• write jest config in typescript (#​588) (eb6ceeb)

v4.24.0

Compare Source

Full Changelog: v4.23.0...v4.24.0

Features

• api: add additional instructions for runs (#​586) (401d93e)

Chores

• deps: update dependency start-server-and-test to v2.0.3 (#​580) (8e1aca1)
• deps: update dependency ts-jest to v29.1.1 (#​578) (a6edb7b)
• deps: update jest (#​582) (e49e471)
• internal: bump deps (#​583) (2e07b4c)
• internal: update deps (#​581) (7b690dc)

Documentation

• upgrade models in examples to latest version (#​585) (60101a4)

v4.23.0

Compare Source

Full Changelog: v4.22.1...v4.23.0

Features

• api: add token logprobs to chat completions (#​576) (8d4292e)

Chores

• ci: run release workflow once per day (#​574) (529f09f)

v4.22.1

Compare Source

Full Changelog: v4.22.0...v4.22.1

Chores

• update dependencies (#​572) (a51e620)

Documentation

• replace runFunctions with runTools in readme (#​570) (c3b9ad5)

v4.22.0

Compare Source

Full Changelog: v4.21.0...v4.22.0

Features

• api: add optional name argument + improve docs (#​569) (3b68ace)

Chores

• update prettier (#​567) (83dec2a)

v4.21.0

Compare Source

Full Changelog: v4.20.1...v4.21.0

Features

• client: support reading the base url from an env variable (#​547) (06fb68d)

Bug Fixes

• correct some runTools behavior and deprecate runFunctions (#​562) (f5cdd0f)
• prevent 400 when using runTools/runFunctions with Azure OpenAI API (#​544) (735d9b8)

Documentation

• readme: update example snippets (#​546) (566d290)

Build System

• specify packageManager: yarn (#​561) (935b898)

v4.20.1

Compare Source

Full Changelog: v4.20.0...v4.20.1

Chores

• internal: remove file import and conditionally run prepare (#​533) (48cb729)

Documentation

• readme: fix typo and add examples link (#​529) (cf959b1)

v4.20.0

Compare Source

Full Changelog: v4.19.1...v4.20.0

Features

• allow installing package directly from github (#​522) (51926d7)

Chores

• internal: don't call prepare in dist (#​525) (d09411e)

v4.19.1

Compare Source

Full Changelog: v4.19.0...v4.19.1

v4.19.0

Compare Source

Full Changelog: v4.18.0...v4.19.0

Features

• api: updates (#​501) (944d58e)

v4.18.0

Compare Source

Full Changelog: v4.17.5...v4.18.0

Features

• api: add gpt-3.5-turbo-1106 (#​496) (45f7672)

v4.17.5

Compare Source

Full Changelog: v4.17.4...v4.17.5

Chores

• fix typo in docs and add request header for function calls (#​494) (22ce244)

v4.17.4

Compare Source

Full Changelog: v4.17.3...v4.17.4

Chores

• internal: update jest config (#​482) (3013e8c)

v4.17.3

Compare Source

Full Changelog: v4.17.2...v4.17.3

v4.17.2

Compare Source

Full Changelog: v4.17.1...v4.17.2

Chores

• internal: bump deno version number (#​478) (69913f3)

v4.17.1

Compare Source

Full Changelog: v4.17.0...v4.17.1

Refactors

• client: deprecate files.retrieveContent in favour of files.content (#​474) (7c7bfc2)

v4.17.0

Compare Source

Full Changelog: v4.16.2...v4.17.0

Features

• api: unify function types (#​467) (d51cd94)

Refactors

• api: rename FunctionObject to FunctionDefinition (#​470) (f3990c7)

v4.16.2

Compare Source

Full Changelog: v4.16.1...v4.16.2

Bug Fixes

• api: accidentally required params, add new models & other fixes (#​463) (1cb403e)
• api: update embedding response object type (#​466) (53b7e25)
• asssitant_deleted -> assistant_deleted (#​452) (ef89bd7)
• types: ensure all code paths return a value (#​458) (19402c3)

Chores

• docs: fix github links (#​457) (6b9b94e)
• internal: fix typo in comment (#​456) (fe24342)

Documentation

• update deno deploy link to include v (#​441) (47b13aa)

v4.16.1

Compare Source

Full Changelog: v4.16.0...v4.16.1

Bug Fixes

• api: retreival -> retrieval (#​437) (b4bd3ee)

Documentation

• api: improve docstrings (#​435) (ee8b24c)

v4.16.0

Compare Source

Full Changelog: v4.15.4...v4.16.0

Features

• api: releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#​433) (fb92f5e)

Bug Fixes

• improve deno readme (#​429) (871ceac)

Documentation

• deno version (#​432) (74bf336)
• update deno link in more places (#​431) (5da63d4)

v4.15.4

Compare Source

Full Changelog: v4.15.3...v4.15.4

Documentation

• readme: remove redundant whitespace (#​427) (aa3a178)

v4.15.3

Compare Source

Full Changelog: v4.15.2...v4.15.3

Bug Fixes

• improve deno releases (#​425) (19469f2)

v4.15.2

Compare Source

Full Changelog: v4.15.1...v4.15.2

Documentation

• fix deno.land import (#​423) (e5415a2)

v4.15.1

Compare Source

Full Changelog: v4.15.0...v4.15.1

Documentation

• document customizing fetch (#​420) (1ca982f)

v4.15.0

Compare Source

Full Changelog: v4.14.2...v4.15.0

Features

• beta: add streaming and function calling helpers (#​409) (510c1f3)
• client: allow binary returns (#​416) (02f7ad7)
• github: include a devcontainer setup (#​413) (fb2996f)
• streaming improvements (#​411) (37b622c)

v4.14.2

Compare Source

Full Changelog: v4.14.1...v4.14.2

Chores

• docs: update deno link (#​407) (0328882)

v4.14.1

Compare Source

Full Changelog: v4.14.0...v4.14.1

Bug Fixes

• deploy deno in a github workflow instead of postpublish step (#​405) (3a6dba0)
• typo in build script (#​403) (76c5c96)

Chores

• internal: update gitignore (#​406) (986b0bb)

v4.14.0

Compare Source

Full Changelog: v4.13.0...v4.14.0

Features

• client: adjust retry behavior to be exponential backoff (#​400) (2bc14ce)

Chores

• docs: update deno version (#​399) (cdee077)

v4.13.0

Compare Source

Full Changelog: v4.12.4...v4.13.0

Features

• api: add embeddings encoding_format (#​390) (cf70dea)
• handle 204 No Content gracefully (#​391) (2dd005c)

v4.12.4

Compare Source

Full Changelog: v4.12.3...v4.12.4

Bug Fixes

• import web-streams-polyfill without overriding globals (#​385) (be8e18b)

v4.12.3

Compare Source

Full Changelog: v4.12.2...v4.12.3

Documentation

• organisation -> organization (UK to US English) (#​382) (516f0ad)

v4.12.2

Compare Source

Full Changelog: v4.12.1...v4.12.2

Bug Fixes

• client: correctly handle errors during streaming (#​377) (09233b1)
• client: correctly handle errors during streaming (#​379) (9ced580)
• improve status code in error messages (#​381) (68dfb17)

Chores

• add case insensitive get header function (#​373) (b088998)
• internal: add debug logs for stream responses (#​380) (689db0b)
• show deprecation notice on re-export (#​368) (b176703)
• update comment (#​376) (a06c685)
• update comment (#​378) (b04031d)

Refactors

• streaming: change Stream constructor signature (#​370) (71984ed)
• test: refactor authentication tests (#​371) (e0d459f)

v4.12.1

Compare Source

Full Changelog: v4.12.0...v4.12.1

Bug Fixes

• fix namespace exports regression (#​366) (b2b1d85)

v4.12.0

Compare Source

Full Changelog: v4.11.1...v4.12.0

Features

• api: remove content_filter stop_reason and update documentation (#​352) (a4b401e)
• re-export chat completion types at the top level, and work around webpack limitations (#​365) (bb815d0)

Bug Fixes

• prevent ReferenceError, update compatibility to ES2020 and Node 18+ (#​356) (fc71a4b)

Chores

• internal: minor formatting improvement (#​354) (3799863)

v4.11.1

Compare Source

Full Changelog: v4.11.0...v4.11.1

v4.11.0

Compare Source

Full Changelog: v4.10.0...v4.11.0

Features

• client: handle retry-after with a date (#​340) (b6dd384)
• package: export a root error type (#​338) (462bcda)

Bug Fixes

• api: add content_filter to chat completion finish reason (#​344) (f10c757)

Chores

• internal: bump lock file (#​334) (fd2337b)
• internal: update lock file (#​339) (1bf84b6)
• internal: update lock file (#​342) (0001f06)
• internal: update lock file (#​343) (a02ac8e)

v4.10.0

Compare Source

Full Changelog: v4.9.1...v4.10.0

Features

• api: add 'gpt-3.5-turbo-instruct', fine-tune error objects, update documentation (#​329) (e5f3852)

v4.9.1

Compare Source

Full Changelog: v4.9.0...v4.9.1

Documentation

• README: fix variable names in some examples (#​327) (5e05b31)

v4.9.0

Compare Source

Full Changelog: v4.8.0...v4.9.0

Features

• client: support importing node or web shims manually (#​325) (628f293)

v4.8.0

Compare Source

Full Changelog: v4.7.1...v4.8.0

Features

• errors: add status code to error message (#​315) (9341219)

v4.7.1

Compare Source

Full Changelog: v4.7.0...v4.7.1

Documentation

• declare Bun 1.0 officially supported (#​314) (a16e268)

v4.7.0

Compare Source

Full Changelog: v4.6.0...v4.7.0

Features

• client: retry on 408 Request Timeout (#​310) (1f98eac)
• make docs urls in comments absolute (#​306) (9db3819)

v4.6.0

Compare Source

Full Changelog: v4.5.0...v4.6.0

Features

• types: extract ChatCompletionRole enum to its own type (#​298) (5893e37)

Bug Fixes

• fix module not found errors in Vercel edge (#​300) (47c79fe)

v4.5.0

Compare Source

Full Changelog: v4.4.0...v4.5.0

Features

• client: add files.waitForProcessing() method (#​292) (ef59010)
• fixes tests where an array has to have unique enum values (#​290) (a10b895)
• make docs more readable by eliminating unnecessary escape sequences (#​287) (a068043)

Bug Fixes

• client: fix TS errors that appear when users Go to Source in VSCode (#​281) (8dc59bc), closes #​249
• client: handle case where the client is instantiated with a undefined baseURL (#​285) (5095cf3)
• client: use explicit file extensions in _shims imports (#​276) (16fe929)

Documentation

• api: update docstrings (#​286) (664e953)
• readme: add link to api.md (#​291) (0d1cce2)

v4.4.0

Compare Source

Full Changelog: v4.3.1...v4.4.0

Features

• package: add Bun export map (#​269) (16f239c)
• re-export chat completion types at the top level (#​268) (1a71a39)
• tests: unskip multipart form data tests (#​275) (47d3e18)
• types: fix ambiguous auto-import for chat completions params (#​266) (19c99fb)

Bug Fixes

• revert import change which triggered circular import bug in webpack (#​274) (6534e36)

v4.3.1

Compare Source

Full Changelog: v4.3.0...v4.3.1

Bug Fixes

• types: improve getNextPage() return type (#​262) (245a984)

Chores

• ci: setup workflows to create releases and release PRs (#​259) (290908c)

v4.3.0

Compare Source

Features

• client: add auto-pagination to fine tuning list endpoints (#​254) (5f89c5e)
• cli: rewrite in JS for better compatibility (#​244) (d8d7c05)

Bug Fixes

• stream: declare Stream.controller as public (#​252) (81e5de7)

Documentation

• readme: mention Azure support (#​253) (294727a)

Chores

• internal: add helper method (#​255) (6d8cff0)

v4.2.0

Compare Source

Features

• types: export RequestOptions type (#​240) (ecf3bce)

Chores

• internal: export HeadersInit type shim (#​241) (cf9f672)

v4.1.0

Compare Source

Full Changelog: openai/openai-node@v4.0.1...v4.1.0

v4.0.1

Compare Source

Full Changelog: openai/openai-node@v4.0.0...v4.0.1

v4.0.0

Compare Source

Version 4 is a complete rewrite of the SDK, offering a huge set of improvements.

What's new

• Streaming support for completions and chat completions!
• Improved typescript types for responses & errors
• Support for ESM, CloudFlare Workers, Vercel edge functions, Deno, and more
• Better file upload API for Whisper, fine-tune files, & DALL·E images
• Improved error handling through automatic retries & error classes
• Improved latency through reusing TCP connections
• Simpler initialization logic

Getting started

npm install [email protected]

Migration guide

➡️ View the v3 to v4 migration guide

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.