CHANGELOG.md

Changelog

0.28.0 (2024-05-30)

Full Changelog: v0.27.0...v0.28.0

⚠ BREAKING CHANGES

• streaming: remove old event_handler API (#532)

Refactors

• streaming: remove old event_handler API (#532) (d9acfd4)

0.27.0 (2024-05-30)

Full Changelog: v0.26.2...v0.27.0

Features

• api: tool use is GA and available on 3P (#530) (ad7adbd)
• streaming/messages: refactor to event iterator structure (997af69)
• streaming/tools: refactor to event iterator structure (bdcc283)
• streaming: add tools support (9f00950)

Bug Fixes

• beta: streaming breakage due to breaking change in dependency (afe3c87)

Chores

• add missing all definitions (#526) (5021787)
• examples: update tools (56edecc)
• formatting: misc fixups (fbad5a0)
• internal: fix lint issues in tests (d857640)
• internal: update bootstrap script (#527) (93ae152)
• internal: update some references to rye-up.com (00e34e7)
• tests: ensure messages.create() and messages.stream() stay in sync (52bd67b)

Documentation

• helpers: mention input json event (02d482c)
• helpers: update for new event iterator (26f9533)

Refactors

• api: add Raw prefix to API stream event type names (#529) (bb62980)

0.26.2 (2024-05-27)

Full Changelog: v0.26.1...v0.26.2

Bug Fixes

• vertex: don't error if project_id couldn't be loaded if it was already explicitly given (#513) (e7159d8)

Chores

• ci: update rye install location (#516) (a6e347a)
• ci: update rye install location (#518) (5122420)
• internal: bump pyright (196e4b0)
• internal: remove unused __events stream property (472b831)
• internal: restructure streaming implementation to use composition (b1a1c03)
• messages: add back-compat for isinstance() checks (7794bcb)
• tests: fix lints (#521) (d96fc53)

Documentation

• contributing: update references to rye-up.com (6486898)

0.26.1 (2024-05-21)

Full Changelog: v0.26.0...v0.26.1

Chores

• docs: fix typo (#511) (d7401bd)
• tools: rely on pydantic's JSON parser instead of pydantic (#510) (8e7edca)

0.26.0 (2024-05-16)

Full Changelog: v0.25.9...v0.26.0

Features

• api: add tool_choice param, image block params inside tool_result.content, and streaming for tool_use blocks (#502) (e0bc274)

Chores

• internal: minor formatting changes (#500) (8b32558)

0.25.9 (2024-05-14)

Full Changelog: v0.25.8...v0.25.9

Bug Fixes

• types: correct type for InputSchema (#498) (b86936c)

Chores

• docs: add SECURITY.md (#493) (d5cba46)
• internal: add slightly better logging to scripts (#497) (acb0149)
• internal: bump pydantic dependency (#495) (00cd840)
• types: add union discriminator metadata (#491) (95544a9)

0.25.8 (2024-05-07)

Full Changelog: v0.25.7...v0.25.8

Chores

• client: log response headers in debug mode (#480) (d1c4d14)
• internal: add link to openapi spec (#484) (876cd0d)
• internal: add scripts/test, scripts/mock and add ci job (#486) (6111fe8)
• internal: bump prism version (#487) (98fb3e6)

Documentation

• readme: fix misleading timeout example value (#489) (b465bce)

0.25.7 (2024-04-29)

Full Changelog: v0.25.6...v0.25.7

Bug Fixes

• docs: doc improvements (#472) (1b6d4e2)

Chores

• internal: minor reformatting (#478) (de4b2e0)
• internal: reformat imports (#477) (553e955)
• internal: restructure imports (#470) (49e0044)
• internal: update test helper function (#476) (f46e454)
• internal: use actions/checkout@v4 for codeflow (#474) (8b18b52)
• tests: rename test file (#473) (5b8261c)

0.25.6 (2024-04-18)

Full Changelog: v0.25.5...v0.25.6

Chores

• internal: bump pyright to 1.1.359 (#466) (8088160)

0.25.5 (2024-04-17)

Full Changelog: v0.25.4...v0.25.5

Chores

• internal: ban usage of lru_cache (#464) (dc8ca22)

0.25.4 (2024-04-17)

Full Changelog: v0.25.3...v0.25.4

Bug Fixes

• bedrock: correct auth implementation (#462) (2f456f5)

0.25.3 (2024-04-17)

Full Changelog: v0.25.2...v0.25.3

Chores

• bedrock: cache boto sessions (#455) (d58adef)

0.25.2 (2024-04-15)

Full Changelog: v0.25.1...v0.25.2

Chores

• internal: formatting (#452) (8ac016b)

0.25.1 (2024-04-11)

Full Changelog: v0.25.0...v0.25.1

Chores

• fix typo (#449) (420a6c5)

0.25.0 (2024-04-09)

Full Changelog: v0.24.0...v0.25.0

Features

• bedrock: add copy / with_options to bedrock client (8af7c41)

Chores

• unknown commit message (8af7c41)

0.24.0 (2024-04-09)

Full Changelog: v0.23.1...v0.24.0

Features

• client: add DefaultHttpxClient and DefaultAsyncHttpxClient (#444) (51d2427)
• models: add to_dict & to_json helper methods (#446) (6709f58)

0.23.1 (2024-04-04)

Full Changelog: v0.23.0...v0.23.1

Documentation

• readme: mention tool use (#441) (e6cd916)

0.23.0 (2024-04-04)

Full Changelog: v0.22.1...v0.23.0

Features

• api: tool use beta (#438) (5e35ffe)

0.22.1 (2024-04-04)

Full Changelog: v0.22.0...v0.22.1

Bug Fixes

• types: correctly mark type as a required property in requests (#435) (efc35ec)

Chores

• types: consistent naming for text block types (#437) (e979fe1)

0.22.0 (2024-04-04)

Full Changelog: v0.21.3...v0.22.0

Features

• client: increase default HTTP max_connections to 1000 and max_keepalive_connections to 100 (#428) (9a43940)
• package: export default constants (#423) (0d694e1)

Bug Fixes

• client: correct logic for line decoding in streaming (#433) (6bf9379)
• project: use absolute github links on PyPi (#427) (cbd8b1c)
• revert regression with 3.7 support (#419) (fa21f36)
• streaming: correct accumulation of output tokens (#426) (b50ed05)

Chores

• client: validate that max_retries is not None (#430) (31b2a2f)
• internal: bump dependencies (#421) (30e8031)
• internal: defer model build for import latency (#431) (51d4783)
• internal: formatting change (#415) (1474f44)

Documentation

• contributing: fix typo (#414) (aeaf995)
• readme: change undocumented params wording (#429) (1336958)

0.21.3 (2024-03-21)

Full Changelog: v0.21.2...v0.21.3

Bug Fixes

• types: correct typo claude-2.1' to claude-2.1 (#400) (7f82aa3)
• types: correct typo claude-2.1' to claude-2.1 (#413) (bb1aebe)

0.21.2 (2024-03-21)

Full Changelog: v0.21.1...v0.21.2

Documentation

• readme: consistent use of sentence case in headings (#405) (495ca87)
• readme: document how to make undocumented requests (#407) (b046d0d)

0.21.1 (2024-03-20)

Full Changelog: v0.21.0...v0.21.1

Chores

• internal: loosen input type for util function (#402) (9a6ca55)

0.21.0 (2024-03-19)

Full Changelog: v0.20.0...v0.21.0

Features

• vertex: api is no longer in private beta (#399) (4cb0e64)

Performance Improvements

• cache TypeAdapters (#396) (a902c47)

Chores

• internal: update generated pragma comment (#398) (330b61e)

Documentation

• fix typo in CONTRIBUTING.md (#397) (d46629f)
• helpers: fix example code (#391) (9fe0c8b)

0.20.0 (2024-03-13)

Full Changelog: v0.19.2...v0.20.0

Features

• api: add haiku model (#390) (43b57fc)

Documentation

• readme: mention vertex API (#388) (8bb6b98)

0.19.2 (2024-03-11)

Full Changelog: v0.19.1...v0.19.2

Bug Fixes

• vertex: use correct auth scopes (#385) (e4de056)

Chores

• export NOT_GIVEN sentinel value (#379) (ba127bc)
• internal: improve deserialisation of discriminated unions (#386) (fbc7e0b)
• internal: support parsing Annotated types (#377) (f44efd5)

0.19.1 (2024-03-06)

Full Changelog: v0.19.0...v0.19.1

Chores

• internal: add core support for deserializing into number response (#373) (b62c422)

0.19.0 (2024-03-06)

Full Changelog: v0.18.1...v0.19.0

Features

• api: add enum to model param for message (#371) (f96765f)

Chores

• client: improve error message for invalid http_client argument (#367) (2f4df72)

Documentation

• readme: fix async streaming snippet (#366) (37c469d)

0.18.1 (2024-03-04)

Full Changelog: v0.18.0...v0.18.1

Chores

• readme: update bedrock example (#364) (81e4d10)

0.18.0 (2024-03-04)

Full Changelog: v0.17.0...v0.18.0

Features

• bedrock: add messages API (#362) (5409be9)

Chores

• remove old examples (4895381)

0.17.0 (2024-03-04)

Full Changelog: v0.16.0...v0.17.0

Features

• messages: add support for image inputs (#359) (579f013)

Chores

• client: use anyio.sleep instead of asyncio.sleep (#351) (2778a22)
• docs: mention install from git repo (#356) (9d503ba)
• docs: remove references to old bedrock package (#344) (3323883)
• internal: bump pyright (#350) (ee0161c)
• internal: bump rye to v0.24.0 (#348) (be8597b)
• internal: improve bedrock streaming setup (#354) (2b55c68)
• internal: refactor release environment script (#347) (a87443a)
• internal: split up transforms into sync / async (#357) (f55ee71)
• internal: support more input types (#358) (35b0347)
• internal: update deps (#349) (ab82b2d)

Documentation

• contributing: improve wording (#355) (f9093a0)

Refactors

• api: mark completions API as legacy (#346) (2bb25a1)

0.16.0 (2024-02-13)

Full Changelog: v0.15.1...v0.16.0

Features

• api: messages is generally available (#343) (f682594)
• messages: allow message response in params (#339) (86c63f0)

Documentation

• add CONTRIBUTING.md (#340) (78469ad)

0.15.1 (2024-02-07)

Full Changelog: v0.15.0...v0.15.1

Bug Fixes

• prevent crash when platform.architecture() is not allowed (#334) (fefb5c1)
• types: loosen most List params types to Iterable (#338) (6e7761b)

Chores

• internal: add lint command (#337) (2ebaf1d)
• internal: support serialising iterable types (#336) (ea3ed7b)

0.15.0 (2024-02-02)

Full Changelog: v0.14.1...v0.15.0

Features

• api: add new usage response fields (#332) (554098e)

0.14.1 (2024-02-02)

Full Changelog: v0.14.0...v0.14.1

Chores

• interal: make link to api.md relative (#330) (e393317)

0.14.0 (2024-01-31)

Full Changelog: v0.13.0...v0.14.0

Features

• bedrock: include bedrock SDK (#328) (a03f21f)

0.13.0 (2024-01-30)

Full Changelog: v0.12.0...v0.13.0

Features

• client: support parsing custom response types (#325) (416633f)

Chores

• internal: cast type in mocked test (#326) (fd22d8e)
• internal: enable ruff type checking misuse lint rule (#324) (6587598)
• internal: support multipart data with overlapping keys (#322) (9ecab60)
• internal: support pre-release versioning (#327) (78b1bfe)

0.12.0 (2024-01-25)

Full Changelog: v0.11.0...v0.12.0

Features

• client: enable follow redirects by default (#320) (9959c32)

0.11.0 (2024-01-23)

Full Changelog: v0.10.0...v0.11.0

Features

• vertex: add support for google vertex (#319) (5324415)

Chores

• internal: add internal helpers (#316) (8c75cdf)
• internal: update resource client type (#318) (bdd8d84)

0.10.0 (2024-01-18)

Full Changelog: v0.9.0...v0.10.0

Features

• client: add support for streaming raw responses (#307) (f295982)

Bug Fixes

• ci: ignore stainless-app edits to release PR title (#315) (69e8b03)

Chores

• add write_to_file binary helper method (#309) (8ac7988)
• client: improve debug logging for failed requests (#303) (5e58c25)
• internal: fix typing util function (#310) (3671aa6)
• internal: remove redundant client test (#311) (d7140f7)
• internal: share client instances between all tests (#314) (ccf731b)
• internal: speculative retry-after-ms support (#312) (4b27da9)
• internal: updates to proxy helper (#308) (a0b3cdb)
• lazy load raw resource class properties (#313) (b13f824)

Documentation

• readme: improve api reference (#306) (c3ab836)

0.9.0 (2024-01-08)

Full Changelog: v0.8.1...v0.9.0

Features

• add None default value to nullable response properties (#299) (da423db)

Bug Fixes

• client: correctly use custom http client auth (#296) (6289d6e)

Chores

• add .keep files for examples and custom code directories (#302) (73a07ea)
• internal: loosen type var restrictions (#301) (5e5e1e7)
• internal: replace isort with ruff (#298) (7c60904)
• use property declarations for resource members (#300) (8671297)

0.8.1 (2023-12-22)

Full Changelog: v0.8.0...v0.8.1

Chores

• internal: add bin script (#292) (ba2953d)
• internal: fix typos (#287) (4ffbcdf)
• internal: use ruff instead of black for formatting (#294) (1753887)
• package: bump minimum typing-extensions to 4.7 (#290) (9ec5c57)

Documentation

• messages: improvements to helpers reference + typos (#291) (d18a895)
• readme: remove old migration guide (#289) (eec4574)

0.8.0 (2023-12-19)

Full Changelog: v0.7.8...v0.8.0

Features

• api: add messages endpoint with streaming helpers (#286) (c464b87)

Chores

• ci: run release workflow once per day (#282) (3a23912)
• client: only import tokenizers when needed (#284) (b9e38b2)
• streaming: update constructor to use direct client names (#285) (0c55c84)

0.7.8 (2023-12-12)

Full Changelog: v0.7.7...v0.7.8

Bug Fixes

• avoid leaking memory when Client.with_options is used (#275) (5e51ebd)
• client: correct base_url setter implementation (#265) (29d0c8b)
• client: ensure retried requests are closed (#261) (5d9aa75)
• errors: properly assign APIError.body (#274) (342846f)

Chores

• internal: enable more lint rules (#273) (0ac62bc)
• internal: reformat imports (#270) (dc55724)
• internal: reformat imports (#272) (0d82ce4)
• internal: remove unused file (#264) (1bfc69b)
• internal: replace string concatenation with f-strings (#263) (f545c35)
• internal: update formatting (#271) (802ab59)
• package: lift anyio v4 restriction (#266) (a217e99)

Documentation

• update examples to show claude-2.1 (#276) (8f562f4)

Refactors

• client: simplify cleanup (#278) (3611ae2)
• simplify internal error handling (#279) (993b51a)

0.7.7 (2023-11-29)

Full Changelog: v0.7.6...v0.7.7

Chores

• internal: add tests for proxy change (#260) (3b52136)
• internal: updates to proxy helper (#258) (94c4de8)

0.7.6 (2023-11-28)

Full Changelog: v0.7.5...v0.7.6

Chores

• deps: bump mypy to v1.7.1 (#256) (02d4ed8)

0.7.5 (2023-11-24)

Full Changelog: v0.7.4...v0.7.5

Chores

• internal: revert recent options change (#252) (d60d5c3)
• internal: send more detailed x-stainless headers (#254) (a268d4b)

0.7.4 (2023-11-23)

Full Changelog: v0.7.3...v0.7.4

Chores

• internal: options updates (#248) (5a3b236)

0.7.3 (2023-11-21)

Full Changelog: v0.7.2...v0.7.3

Bug Fixes

• client: attempt to parse unknown json content types (#243) (9fc275f)

Chores

• client: improve copy method (#246) (c84563f)
• package: add license classifier metadata (#247) (500d0ca)

0.7.2 (2023-11-17)

Full Changelog: v0.7.1...v0.7.2

Chores

• internal: update type hint for helper function (#241) (3179104)

0.7.1 (2023-11-16)

Full Changelog: v0.7.0...v0.7.1

Documentation

• readme: minor updates (#238) (c40c4e1)

0.7.0 (2023-11-15)

Full Changelog: v0.6.0...v0.7.0

Features

• client: support reading the base url from an env variable (#237) (dd91bfd)

Bug Fixes

• client: correctly flush the stream response body (#230) (a60d543)
• client: retry if SSLWantReadError occurs in the async client (#233) (33b553a)
• client: serialise pydantic v1 default fields correctly in params (#232) (d5e70e8)
• models: mark unknown fields as set in pydantic v1 (#231) (4ce7a1e)

Chores

• internal: fix devcontainer interpeter path (#235) (7f92e25)
• internal: fix typo in NotGiven docstring (#234) (ce5cccc)

Documentation

• fix code comment typo (#236) (7ef0464)
• reword package description (#228) (c18e5ed)

0.6.0 (2023-11-08)

Full Changelog: v0.5.1...v0.6.0

Features

• client: adjust retry behavior to be exponential backoff (#205) (c8a4119)
• client: allow binary returns (#217) (159ddd6)
• client: improve file upload types (#204) (d85d1e0)
• client: support accessing raw response objects (#211) (ebe8e4a)
• client: support passing BaseModels to request params at runtime (#218) (9f04ea6)
• client: support passing chunk size for binary responses (#227) (c88f01e)
• client: support passing httpx.Timeout to method timeout argument (#222) (ef58166)
• github: include a devcontainer setup (#216) (c9fee19)
• package: add classifiers (#214) (380967e)

Bug Fixes

• binaries: don't synchronously block in astream_to_file (#219) (2a2a617)
• prevent TypeError in Python 3.8 (ABC is not subscriptable) (#221) (893e885)

Chores

• docs: fix github links (#225) (dfa9935)
• internal: fix some typos (#223) (9038193)
• internal: improve github devcontainer setup (#226) (3cd90ab)
• internal: minor restructuring of base client (#213) (60dc609)
• internal: remove unused int/float conversion (#220) (a6bf20d)
• internal: require explicit overrides (#210) (72f4339)

Documentation

• fix github links (#215) (8cbed15)
• improve to dictionary example (#207) (5e32c20)

0.5.1 (2023-10-20)

Full Changelog: v0.5.0...v0.5.1

Chores

• internal: bump mypy (#203) (aa9a67e)
• internal: bump pyright (#202) (f96f5f7)
• internal: update gitignore (#199) (b92fa57)

0.5.0 (2023-10-18)

Full Changelog: v0.4.1...v0.5.0

Features

• client: support passing httpx.URL instances to base_url (#197) (fe61308)

Chores

• internal: improve publish script (#196) (7c92b90)
• internal: migrate from Poetry to Rye (#194) (1dd605e)
• internal: update gitignore (#198) (4c210b7)

0.4.1 (2023-10-16)

Full Changelog: v0.4.0...v0.4.1

Bug Fixes

• client: accept io.IOBase instances in file params (#190) (5da5f0c)
• streaming: add additional overload for ambiguous stream param (#185) (794dc4d)

Chores

• internal: cleanup some redundant code (#188) (cb0bd8c)
• internal: enable lint rule (#187) (123b5c1)

Documentation

• organisation -> organization (UK to US English) (#192) (901a330)

0.4.0 (2023-10-13)

Full Changelog: v0.3.14...v0.4.0

Features

• client: add logging setup (#177) (a5f87ad)

Bug Fixes

• client: correctly handle arguments with env vars (#178) (91a0e2a)

Chores

• add case insensitive get header function (#182) (708fd02)
• update comment (#183) (649d6f4)
• update README (#174) (bb581b5)

Documentation

• minor readme reordering (#180) (92345e3)

Refactors

• test: refactor authentication tests (#175) (c82da53)

0.3.14 (2023-10-11)

Full Changelog: v0.3.13...v0.3.14

Features

• client: add forwards-compatible pydantic methods (#171) (4c5289e)
• client: add support for passing in a httpx client (#173) (25046c4)
• client: handle retry-after header with a date format (#168) (afeabf1)
• client: retry on 408 Request Timeout (#155) (46386f8)
• package: export a root error type (#163) (e7aa3e7)
• types: improve params type names (#160) (43544a6)

Bug Fixes

• client: don't error by default for unexpected content types (#161) (76cfcf9)
• client: properly configure model set fields (#154) (da6ccb1)

Chores

• internal: add helpers (#156) (00f5a19)
• internal: move error classes from _base_exceptions to _exceptions (⚠️ breaking) (#162) (329b307)
• tests: improve raw response test (#166) (8042473)

Documentation

• add some missing inline documentation (#151) (1f98257)
• update readme (#172) (351095b)

0.3.13 (2023-09-11)

Full Changelog: v0.3.12...v0.3.13

Features

• types: de-duplicate nested streaming params types (#141) (f76f053)

Bug Fixes

• client: properly handle optional file params (#142) (11196b7)

Chores

• internal: add pydantic.generics import for compatibility (#135) (951446d)
• internal: minor restructuring (#137) (e601206)
• internal: minor update (#145) (6a505ef)
• internal: update base client (#143) (8e0dca4)
• internal: update lock file (#147) (a72b5ca)
• internal: update pyright (#149) (9661f94)
• internal: updates (#148) (9f7fbbc)

Documentation

• readme: add link to api.md (#146) (1fcb30a)
• readme: reference pydantic helpers (#138) (ccaab99)

0.3.12 (2023-08-29)

Full Changelog: v0.3.11...v0.3.12

Chores

• ci: setup workflows to create releases and release PRs (#130) (8f1048b)
• internal: use shared params references (#133) (feaf6aa)

0.3.11 (2023-08-26)

Documentation

• readme: make print statements in streaming examples flush (#123) (d24dfaf)

Chores

• internal: update anyio (#125) (34c7fa1)

0.3.10 (2023-08-16)

Features

• add support for Pydantic v2 (#121) (cafa9be)
• allow a default timeout to be set for clients (#117) (a115d2c)

Chores

• assign default reviewers to release PRs (#119) (029a9e1)
• internal: minor formatting change (#120) (7f2f54a)

0.3.9 (2023-08-12)

Features

• docs: remove extraneous space in examples (#109) (6d5c1f7)

Bug Fixes

• docs: correct async imports (1ea1bf3)

Documentation

• readme: remove beta status + document versioning policy (#102) (2f0a0f9)

Chores

• deps: bump typing-extensions to 4.5 (#112) (f903269)
• docs: remove trailing spaces (#113) (e876a6b)
• internal: bump pytest-asyncio (#114) (679ecd0)
• internal: update mypy to v1.4.1 (#100) (f615753)
• internal: update ruff to v0.0.282 (#103) (9db4b34)

0.3.8 (2023-08-01)

Features

• client: add constants to client instances as well (#95) (d0fbe33)

Chores

• internal: bump pyright (#94) (d2872dc)
• internal: make demo example runnable and more portable (#92) (dea1aa2)

Documentation

• readme: add token counting reference (#96) (79a339e)

0.3.7 (2023-07-29)

Features

• client: add client close handlers (#89) (2520a03)

Bug Fixes

• client: correctly handle environment variable access (aa53754)

Documentation

• readme: use client everywhere for consistency (0ff8924)

Chores

• internal: minor refactoring of client instantiation (adf9158)
• internal: minor reformatting of code (#90) (1175572)

0.3.6 (2023-07-22)

Documentation

• readme: reference "client" in errors section and add missing import (#79) (ddc81cf)

0.3.5 (2023-07-19)

Features

• add flexible enum to model param (#75) (d16bb45)

Documentation

• examples: bump model to claude-2 in example scripts (#67) (cd68de2)

Chores

• internal: add codegen.log to .gitignore (#72) (d9b7e30)

0.3.4 (2023-07-11)

Chores

• package: pin major versions of dependencies (#59) (3a75464)

Documentation

• api: reference claude-2 (#61) (91ece29)
• readme: update examples to use claude-2 (#65) (7e4714c)