CHANGELOG.md

Changelog

1.30.1 (2024-05-14)

Full Changelog: v1.30.0...v1.30.1

Chores

• internal: add slightly better logging to scripts (#1422) (43dffab)

1.30.0 (2024-05-14)

Full Changelog: v1.29.0...v1.30.0

Features

• api: add incomplete state (#1420) (6484984)

1.29.0 (2024-05-13)

Full Changelog: v1.28.2...v1.29.0

Features

• api: add gpt-4o model (#1417) (4f09f8c)

1.28.2 (2024-05-13)

Full Changelog: v1.28.1...v1.28.2

Bug Fixes

• client: accidental blocking sleep in async code (#1415) (0ac6ecb)

Chores

• internal: bump pydantic dependency (#1413) (ed73d1d)

1.28.1 (2024-05-11)

Full Changelog: v1.28.0...v1.28.1

Chores

• docs: add SECURITY.md (#1408) (119970a)

1.28.0 (2024-05-09)

Full Changelog: v1.27.0...v1.28.0

Features

• api: add message image content (#1405) (a115de6)

1.27.0 (2024-05-08)

Full Changelog: v1.26.0...v1.27.0

Features

• api: adding file purposes (#1401) (2e9d0bd)

1.26.0 (2024-05-06)

Full Changelog: v1.25.2...v1.26.0

Features

• api: add usage metadata when streaming (#1395) (3cb064b)

1.25.2 (2024-05-05)

Full Changelog: v1.25.1...v1.25.2

Documentation

• readme: fix misleading timeout example value (#1393) (3eba8e7)

1.25.1 (2024-05-02)

Full Changelog: v1.25.0...v1.25.1

Chores

• internal: bump prism version (#1390) (a5830fc)

1.25.0 (2024-05-01)

Full Changelog: v1.24.1...v1.25.0

Features

• api: delete messages (#1388) (d0597cd)

1.24.1 (2024-04-30)

Full Changelog: v1.24.0...v1.24.1

Chores

• internal: add link to openapi spec (#1385) (b315d04)

1.24.0 (2024-04-29)

Full Changelog: v1.23.6...v1.24.0

Features

• api: add required tool_choice (#1382) (c558f65)

Chores

• client: log response headers in debug mode (#1383) (f31a426)
• internal: minor reformatting (#1377) (7003dbb)
• internal: reformat imports (#1375) (2ad0c3b)

1.23.6 (2024-04-25)

Full Changelog: v1.23.5...v1.23.6

Chores

• internal: update test helper function (#1371) (6607c4a)

1.23.5 (2024-04-24)

Full Changelog: v1.23.4...v1.23.5

Chores

• internal: use actions/checkout@v4 for codeflow (#1368) (d1edf8b)

1.23.4 (2024-04-24)

Full Changelog: v1.23.3...v1.23.4

Bug Fixes

• api: change timestamps to unix integers (#1367) (fbc0e15)
• docs: doc improvements (#1364) (8c3a005)

Chores

• tests: rename test file (#1366) (4204e63)

1.23.3 (2024-04-23)

Full Changelog: v1.23.2...v1.23.3

Chores

• internal: restructure imports (#1359) (4e5eb37)

1.23.2 (2024-04-19)

Full Changelog: v1.23.1...v1.23.2

Bug Fixes

• api: correct types for message attachment tools (#1348) (78a6261)

1.23.1 (2024-04-18)

Full Changelog: v1.23.0...v1.23.1

Bug Fixes

• api: correct types for attachments (#1342) (542d30c)

1.23.0 (2024-04-18)

Full Changelog: v1.22.0...v1.23.0

Features

• api: add request id property to response classes (#1341) (444d680)

Documentation

• helpers: fix example snippets (#1339) (8929088)

1.22.0 (2024-04-18)

Full Changelog: v1.21.2...v1.22.0

Features

• api: batch list endpoint (#1338) (a776f38)

Chores

• internal: ban usage of lru_cache (#1331) (8f9223b)
• internal: bump pyright to 1.1.359 (#1337) (feec0dd)

1.21.2 (2024-04-17)

Full Changelog: v1.21.1...v1.21.2

Chores

• internal: add lru_cache helper function (#1329) (cbeebfc)

1.21.1 (2024-04-17)

Full Changelog: v1.21.0...v1.21.1

Chores

• api: docs and response_format response property (#1327) (7a6d142)

1.21.0 (2024-04-17)

Full Changelog: v1.20.0...v1.21.0

Features

• api: add vector stores (#1325) (038a3c5)

1.20.0 (2024-04-16)

Full Changelog: v1.19.0...v1.20.0

Features

• client: add header OpenAI-Project (#1320) (0c489f1)
• extract chat models to a named enum (#1322) (1ccd9b6)

1.19.0 (2024-04-15)

Full Changelog: v1.18.0...v1.19.0

Features

• errors: add request_id property (#1317) (f9eb77d)

1.18.0 (2024-04-15)

Full Changelog: v1.17.1...v1.18.0

Features

• api: add batch API (#1316) (3e6f19e)
• api: updates (#1314) (8281dc9)

1.17.1 (2024-04-12)

Full Changelog: v1.17.0...v1.17.1

Chores

• fix typo (#1304) (1129082)
• internal: formatting (#1311) (8fd411b)

1.17.0 (2024-04-10)

Full Changelog: v1.16.2...v1.17.0

Features

• api: add additional messages when creating thread run (#1298) (70eb081)
• client: add DefaultHttpxClient and DefaultAsyncHttpxClient (#1302) (69cdfc3)
• models: add to_dict & to_json helper methods (#1305) (40a881d)

1.16.2 (2024-04-04)

Full Changelog: v1.16.1...v1.16.2

Bug Fixes

• client: correct logic for line decoding in streaming (#1293) (687caef)

1.16.1 (2024-04-02)

Full Changelog: v1.16.0...v1.16.1

Chores

• internal: defer model build for import latency (#1291) (bc6866e)

1.16.0 (2024-04-01)

Full Changelog: v1.15.0...v1.16.0

Features

• api: add support for filtering messages by run_id (#1288) (58d6b77)
• api: run polling helpers (#1289) (6b427f3)

Chores

• client: validate that max_retries is not None (#1286) (aa5920a)

Refactors

• rename createAndStream to stream (6b427f3)

1.15.0 (2024-03-31)

Full Changelog: v1.14.3...v1.15.0

Features

• api: adding temperature parameter (#1282) (0e68fd3)
• client: increase default HTTP max_connections to 1000 and max_keepalive_connections to 100 (#1281) (340d139)
• package: export default constants (#1275) (fdc126e)

Bug Fixes

• project: use absolute github links on PyPi (#1280) (94cd528)

Chores

• internal: bump dependencies (#1273) (18dcd65)

Documentation

• readme: change undocumented params wording (#1284) (7498ef1)

1.14.3 (2024-03-25)

Full Changelog: v1.14.2...v1.14.3

Bug Fixes

• revert regression with 3.7 support (#1269) (37aed56)

Chores

• internal: construct error properties instead of using the raw response (#1257) (11dce5c)
• internal: formatting change (#1258) (b907dd7)
• internal: loosen input type for util function (#1250) (fc8b4c3)

Documentation

• contributing: fix typo (#1264) (835cb9b)
• readme: consistent use of sentence case in headings (#1255) (519f371)
• readme: document how to make undocumented requests (#1256) (5887858)

1.14.2 (2024-03-19)

Full Changelog: v1.14.1...v1.14.2

Performance Improvements

• cache TypeAdapters (#1114) (41b6fee)
• cache TypeAdapters (#1243) (2005076)

Chores

• internal: update generated pragma comment (#1247) (3eeb9b3)

Documentation

• assistant improvements (#1249) (e7a3176)
• fix typo in CONTRIBUTING.md (#1245) (adef57a)

1.14.1 (2024-03-15)

Full Changelog: v1.14.0...v1.14.1

Documentation

• readme: assistant streaming (#1238) (0fc30a2)

1.14.0 (2024-03-13)

Full Changelog: v1.13.4...v1.14.0

Features

• assistants: add support for streaming (#1233) (17635dc)

1.13.4 (2024-03-13)

Full Changelog: v1.13.3...v1.13.4

Bug Fixes

• streaming: improve error messages (#1218) (4f5ff29)

Chores

• api: update docs (#1212) (71236e0)
• client: improve error message for invalid http_client argument (#1216) (d0c928a)
• docs: mention install from git repo (#1203) (3ab6f44)
• export NOT_GIVEN sentinel value (#1223) (8a4f76f)
• internal: add core support for deserializing into number response (#1219) (004bc92)
• internal: bump pyright (#1221) (3c2e815)
• internal: improve deserialisation of discriminated unions (#1227) (4767259)
• internal: minor core client restructuring (#1199) (4314cdc)
• internal: split up transforms into sync / async (#1210) (7853a83)
• internal: support more input types (#1211) (d0e4baa)
• internal: support parsing Annotated types (#1222) (8598f81)
• types: include discriminators in unions (#1228) (3ba0dcc)

Documentation

• contributing: improve wording (#1201) (95a1e0e)

1.13.3 (2024-02-28)

Full Changelog: v1.13.2...v1.13.3

Features

• api: add wav and pcm to response_format (#1189) (dbd20fc)

Chores

• client: use anyio.sleep instead of asyncio.sleep (#1198) (b6d025b)
• internal: bump pyright (#1193) (9202e04)
• types: extract run status to a named type (#1178) (249ecbd)

Documentation

• add note in azure_deployment docstring (#1188) (96fa995)
• examples: add pyaudio streaming example (#1194) (3683c5e)

1.13.2 (2024-02-20)

Full Changelog: v1.13.1...v1.13.2

Bug Fixes

• ci: revert "move github release logic to github app" (#1170) (f1adc2e)

1.13.1 (2024-02-20)

Full Changelog: v1.13.0...v1.13.1

Chores

• internal: bump rye to v0.24.0 (#1168) (84c4256)

1.13.0 (2024-02-19)

Full Changelog: v1.12.0...v1.13.0

Features

• api: updates (#1146) (79b7675)

Bug Fixes

• api: remove non-GA instance_id param (#1164) (1abe139)

Chores

• ci: move github release logic to github app (#1155) (67cfac2)
• client: use correct accept headers for binary data (#1161) (e536437)
• internal: refactor release environment script (#1158) (7fe8ec3)

1.12.0 (2024-02-08)

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

Features

• api: add timestamp_granularities, add gpt-3.5-turbo-0125 model (#1125) (1ecf8f6)
• cli/images: add support for --model arg (#1132) (0d53866)

Bug Fixes

• remove double brackets from timestamp_granularities param (#1140) (3db0222)
• types: loosen most List params types to Iterable (#1129) (bdb31a3)

Chores

• internal: add lint command (#1128) (4c021c0)
• internal: support serialising iterable types (#1127) (98d4e59)

Documentation

• add CONTRIBUTING.md (#1138) (79c8f0e)

1.11.1 (2024-02-04)

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

Bug Fixes

• prevent crash when platform.architecture() is not allowed (#1120) (9490554)

1.11.0 (2024-02-03)

Full Changelog: v1.10.0...v1.11.0

Features

• client: support parsing custom response types (#1111) (da00fc3)

Chores

• interal: make link to api.md relative (#1117) (4a10879)
• internal: cast type in mocked test (#1112) (99b21e1)
• internal: enable ruff type checking misuse lint rule (#1106) (fa63e60)
• internal: support multipart data with overlapping keys (#1104) (455bc9f)
• internal: support pre-release versioning (#1113) (dea5b08)

1.10.0 (2024-01-25)

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

Features

• api: add text embeddings dimensions param (#1103) (94abfa0)
• azure: proactively add audio/speech to deployment endpoints (#1099) (fdf8742)
• client: enable follow redirects by default (#1100) (d325b7c)

Chores

• internal: add internal helpers (#1092) (629bde5)

Refactors

• remove unnecessary builtin import (#1094) (504b7d4)

1.9.0 (2024-01-21)

Full Changelog: v1.8.0...v1.9.0

Features

• api: add usage to runs and run steps (#1090) (6c116df)

Chores

• internal: fix typing util function (#1083) (3e60db6)
• internal: remove redundant client test (#1085) (947974f)
• internal: share client instances between all tests (#1088) (05cd753)
• internal: speculative retry-after-ms support (#1086) (36a7576)
• lazy load raw resource class properties (#1087) (d307127)

1.8.0 (2024-01-16)

Full Changelog: v1.7.2...v1.8.0

Features

• client: add support for streaming raw responses (#1072) (0e93c3b)

Bug Fixes

• client: ensure path params are non-empty (#1075) (9a25149)
• proxy: prevent recursion errors when debugging pycharm (#1076) (3d78798)

Chores

• add write_to_file binary helper method (#1077) (c622c6a)

1.7.2 (2024-01-12)

Full Changelog: v1.7.1...v1.7.2

Documentation

• readme: improve api reference (#1065) (745b9e0)

Refactors

• api: remove deprecated endpoints (#1067) (199ddcd)

1.7.1 (2024-01-10)

Full Changelog: v1.7.0...v1.7.1

Chores

• client: improve debug logging for failed requests (#1060) (cf9a651)

1.7.0 (2024-01-08)

Full Changelog: v1.6.1...v1.7.0

Features

• add None default value to nullable response properties (#1043) (d94b4d3)

Bug Fixes

• client: correctly use custom http client auth (#1028) (3d7d93e)

Chores

• add .keep files for examples and custom code directories (#1057) (7524097)
• internal: bump license (#1037) (d828527)
• internal: loosen type var restrictions (#1049) (e00876b)
• internal: replace isort with ruff (#1042) (f1fbc9c)
• internal: update formatting (#1041) (2e9ecee)
• src: fix typos (#988) (6a8b806)
• use property declarations for resource members (#1047) (131f6bc)

Documentation

• fix docstring typos (#1022) (ad3fd2c)
• improve audio example to show how to stream to a file (#1017) (d45ed7f)

1.6.1 (2023-12-22)

Full Changelog: v1.6.0...v1.6.1

Chores

• internal: add bin script (#1001) (99ffbda)
• internal: use ruff instead of black for formatting (#1008) (ceaf9a0)

1.6.0 (2023-12-19)

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

Features

• api: add additional instructions for runs (#995) (7bf9b75)

Chores

• cli: fix typo in completions (#985) (d1e9e8f)
• cli: fix typo in completions (#986) (626bc34)
• internal: fix binary response tests (#983) (cfb7e30)
• internal: fix typos (#993) (3b338a4)
• internal: minor utils restructuring (#992) (5ba576a)
• package: bump minimum typing-extensions to 4.7 (#994) (0c2da84)
• streaming: update constructor to use direct client names (#991) (6c3427d)

Documentation

• upgrade models in examples to latest version (#989) (cedd574)

1.5.0 (2023-12-17)

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

Features

• api: add token logprobs to chat completions (#980) (f50e962)

Chores

• ci: run release workflow once per day (#978) (215476a)

1.4.0 (2023-12-15)

Full Changelog: v1.3.9...v1.4.0

Features

• api: add optional name argument + improve docs (#972) (7972010)

1.3.9 (2023-12-12)

Full Changelog: v1.3.8...v1.3.9

Documentation

• improve README timeout comment (#964) (3c3ed5e)
• small Improvement in the async chat response code (#959) (fb9d0a3)
• small streaming readme improvements (#962) (f3be2e5)

Refactors

• client: simplify cleanup (#966) (5c138f4)
• simplify internal error handling (#968) (d187f6b)

1.3.8 (2023-12-08)

Full Changelog: v1.3.7...v1.3.8

Bug Fixes

• avoid leaking memory when Client.with_options is used (#956) (e37ecca)
• errors: properly assign APIError.body (#949) (c70e194)
• pagination: use correct type hint for .object (#943) (23fe7ee)

Chores

• internal: enable more lint rules (#945) (2c8add6)
• internal: reformat imports (#939) (ec65124)
• internal: reformat imports (#944) (5290639)
• internal: update formatting (#941) (8e5a156)
• package: lift anyio v4 restriction (#927) (be0438a)

Documentation

• fix typo in example (#950) (54f0ce0)

1.3.7 (2023-12-01)

Full Changelog: v1.3.6...v1.3.7

Bug Fixes

• client: correct base_url setter implementation (#919) (135d9cf)
• client: don't cause crashes when inspecting the module (#897) (db029a5)
• client: ensure retried requests are closed (#902) (e025e6b)

Chores

• internal: add tests for proxy change (#899) (71a13d0)
• internal: remove unused type var (#915) (4233bcd)
• internal: replace string concatenation with f-strings (#908) (663a8f6)
• internal: replace string concatenation with f-strings (#909) (caab767)

Documentation

• fix typo in readme (#904) (472cd44)
• readme: update example snippets (#907) (bbb648e)

1.3.6 (2023-11-28)

Full Changelog: v1.3.5...v1.3.6

Bug Fixes

• client: add support for streaming binary responses (#866) (2470d25)

Chores

• deps: bump mypy to v1.7.1 (#891) (11fcb2a)
• internal: send more detailed x-stainless headers (#877) (69e0549)
• revert binary streaming change (#875) (0a06d6a)

Documentation

• readme: minor updates (#894) (5458457)
• readme: update examples (#893) (124da87)
• update readme code snippet (#890) (c522f21)

1.3.5 (2023-11-21)

Full Changelog: v1.3.4...v1.3.5

Bug Fixes

• azure: ensure custom options can be passed to copy (#858) (05ca0d6)

Chores

• package: add license classifier (#826) (bec004d)
• package: add license classifier metadata (#860) (80dffb1)

1.3.4 (2023-11-21)

Full Changelog: v1.3.3...v1.3.4

Bug Fixes

• client: attempt to parse unknown json content types (#854) (ba50466)

Chores

• examples: fix static types in assistants example (#852) (5b47b2c)

1.3.3 (2023-11-17)

Full Changelog: v1.3.2...v1.3.3

Chores

• internal: update type hint for helper function (#846) (9a5966c)

1.3.2 (2023-11-16)

Full Changelog: v1.3.1...v1.3.2

Documentation

• readme: minor updates (#841) (7273ad1)

1.3.1 (2023-11-16)

Full Changelog: v1.3.0...v1.3.1

Chores

• internal: add publish script (#838) (3ea41bc)

1.3.0 (2023-11-15)

Full Changelog: v1.2.4...v1.3.0

Features

• api: add gpt-3.5-turbo-1106 (#813) (9bb3c4e)
• client: support reading the base url from an env variable (#829) (ca5fdc6)

Bug Fixes

• breaking!: correct broken type names in moderation categories (#811) (0bc211f)

Chores

• fix typo in docs and add request header for function calls (#807) (cbef703)
• internal: fix devcontainer interpeter path (#810) (0acc07d)

Documentation

• add azure env vars (#814) (bd8e32a)
• fix code comment typo (#790) (8407a27)
• readme: fix broken azure_ad notebook link (#781) (3b92cdf)

1.2.4 (2023-11-13)

Full Changelog: v1.2.3...v1.2.4

Bug Fixes

• client: retry if SSLWantReadError occurs in the async client (#804) (be82288)

1.2.3 (2023-11-10)

Full Changelog: v1.2.2...v1.2.3

Bug Fixes

• cli/audio: file format detection failing for whisper (#733) (01079d6)
• client: correctly flush the stream response body (#771) (0d52731)
• client: serialise pydantic v1 default fields correctly in params (#776) (d4c49ad)
• models: mark unknown fields as set in pydantic v1 (#772) (ae032a1)
• prevent IndexError in fine-tunes CLI (#768) (42f1633)

Documentation

• reword package description (#764) (9ff10df)

1.2.2 (2023-11-09)

Full Changelog: v1.2.1...v1.2.2

Bug Fixes

• client: correctly assign error properties (#759) (ef264d2)

Documentation

• readme: link to migration guide (#761) (ddde839)

1.2.1 (2023-11-09)

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

Documentation

• readme: fix nested params example (#756) (ffbe5ec)

Refactors

• client: deprecate files.retrieve_content in favour of files.content (#753) (eea5bc1)

1.2.0 (2023-11-08)

Full Changelog: v1.1.2...v1.2.0

Features

• api: unify function types (#741) (ed16c4d)
• client: support passing chunk size for binary responses (#747) (c0c89b7)

Bug Fixes

• api: update embedding response object type (#739) (29182c4)
• client: show a helpful error message if the v0 API is used (#743) (920567c)

Chores

• internal: improve github devcontainer setup (#737) (0ac1abb)

Refactors

• api: rename FunctionObject to FunctionDefinition (#746) (1afd138)

1.1.2 (2023-11-08)

Full Changelog: v1.1.1...v1.1.2

Bug Fixes

• api: accidentally required params, add new models & other fixes (#729) (03c3e03)
• asssitant_deleted -> assistant_deleted (#711) (287b51e)

Chores

• docs: fix github links (#719) (0cda8ca)
• internal: fix some typos (#718) (894ad87)