anthropic-sdk-beta 0.1.0.pre.beta.6 → 0.1.0.pre.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3770cc0fc2647cc729911cfb5c24a7757952d580699391fd73f31baffa2f6296
-  data.tar.gz: ec0725750578611e98b32f1a451a179a8176269a8a55178ade68f4137e6cb4ea
+  metadata.gz: 00c97457f993b57bfa54518c2dcb7e2803e57b6e0b95945e092203237365cda9
+  data.tar.gz: 4eeed4f7e125f383408ac8fd26d64a1f848c629f60d5aa8c330a02d6bb166544
 SHA512:
-  metadata.gz: b4191bb25c64ef84c1bf7bcdbbf4b222d6d77b135fdc2ef5efad7dad1f3b51a5babb332624a6303809abf03c714ed94f1cfa09b0f008f077179edc50894dbbbb
-  data.tar.gz: 27be2cbd47ef05a625da53c264e16ea76bdfda7f4cc9db1a727627b1cd4feb24939b1c8ded1584edb47924afc5da1f299789d4bded01504e12a831df1613307f
+  metadata.gz: 1b3bb5172a2bcec1683c1f56ccdce051d277f3ca92399463fd9f26a845950a29bece5d95517f43782b96214cf2c59288785581e559e9e0737c32149421297c40
+  data.tar.gz: d4e75f974863994c07fe6308be6b0d8a8cd13fc63a4bd155e2d16837f3c51ecf5de5e8cc619935496810b939c4d81487abd4db477c1797a8e722682add47da23

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -1,5 +1,93 @@
 # Changelog
 
+## 0.1.0-beta.7 (2025-05-15)
+
+Full Changelog: [v0.1.0-beta.6...v0.1.0-beta.7](https://github.com/anthropics/anthropic-sdk-ruby/compare/v0.1.0-beta.6...v0.1.0-beta.7)
+
+### ⚠ BREAKING CHANGES
+
+* rename Vertex::Client and Bedrock::Client to VertexClient and BedrockClient
+
+### Features
+
+* bump default connection pool size limit to minimum of 99 ([5170cb6](https://github.com/anthropics/anthropic-sdk-ruby/commit/5170cb6172644012bb6f2580a6789c965088a01a))
+* **client:** enable setting base URL from environment variable ([9cb10b1](https://github.com/anthropics/anthropic-sdk-ruby/commit/9cb10b1491761bb101269b92f4229183355ff77b))
+* expose base client options as read only attributes ([2813fa7](https://github.com/anthropics/anthropic-sdk-ruby/commit/2813fa78dbc68c7c38cf0b00141f758fda2ff7c3))
+* expose recursive `#to_h` conversion ([386a6a7](https://github.com/anthropics/anthropic-sdk-ruby/commit/386a6a78e1ca1f28841a6883d7a72433a9bd40a9))
+* implement `#hash` for data containers ([f289994](https://github.com/anthropics/anthropic-sdk-ruby/commit/f2899941f30d6ce62414a1a866a5c9b47d54c340))
+* rename Vertex::Client and Bedrock::Client to VertexClient and BedrockClient ([0506c4f](https://github.com/anthropics/anthropic-sdk-ruby/commit/0506c4f850ed6e289766ebcef7780aeee078398f))
+* support sorbet aliases at the runtime ([239b6bb](https://github.com/anthropics/anthropic-sdk-ruby/commit/239b6bb99ad9a6549d30e15dfa7dffe7748fca3f))
+* support specifying content-type with FilePart class ([d81f97d](https://github.com/anthropics/anthropic-sdk-ruby/commit/d81f97d27b72fcb30813d037c420657878f78c54))
+* support webmock for testing ([91c3d67](https://github.com/anthropics/anthropic-sdk-ruby/commit/91c3d6748c9ead461bbffcd2fac8c621a357160c))
+
+
+### Bug Fixes
+
+* always send idempotency header when specified as a request option ([c53396e](https://github.com/anthropics/anthropic-sdk-ruby/commit/c53396ea8e8b3afdb572c338af34f7bb0a712151))
+* **client:** send correct HTTP path ([4ff371b](https://github.com/anthropics/anthropic-sdk-ruby/commit/4ff371b538e07f3a2ab6c7c4be72616bf425789b))
+* ensure gem release is unaffected by renaming ([9dbcb33](https://github.com/anthropics/anthropic-sdk-ruby/commit/9dbcb339381980f9e3e809dda6e9f9fe7133463e))
+* **internal:** ensure formatting always uses c.utf-8 locale ([8cdaf4e](https://github.com/anthropics/anthropic-sdk-ruby/commit/8cdaf4ec891bb4b52af12f194d83a8a65d20f72d))
+* **internal:** fix formatting script for macos ([acf7bb0](https://github.com/anthropics/anthropic-sdk-ruby/commit/acf7bb0313f4ead5b714864fcd8ca65e9a7a5999))
+* **internal:** update gemspec name ([6e1994d](https://github.com/anthropics/anthropic-sdk-ruby/commit/6e1994d2742d7915aceec13b51e25c700c9b82c2))
+* make a typo for `FilePart.content` ([8dee858](https://github.com/anthropics/anthropic-sdk-ruby/commit/8dee858a316df5faa7e9e9153f79eee8c558c4d3))
+* vertex and bedrock sorbet types ([de4bf33](https://github.com/anthropics/anthropic-sdk-ruby/commit/de4bf3384ee0047e570baee5c7dfe13a2d53aa2b))
+
+
+### Chores
+
+* accept all nd-json mimetype variants ([1a0c3e3](https://github.com/anthropics/anthropic-sdk-ruby/commit/1a0c3e350ac480539d84fe11edb8bc8a7bde75ba))
+* add generator safe directory ([cbaa546](https://github.com/anthropics/anthropic-sdk-ruby/commit/cbaa54667b544ac6afbe182fa88a59f4dda51b80))
+* always check if current page is empty in `next_page?` ([ef41b35](https://github.com/anthropics/anthropic-sdk-ruby/commit/ef41b35500600a1c1f02f201832855762d49e2e2))
+* amend Gemfile.lock SHA for git dependency ([617d7df](https://github.com/anthropics/anthropic-sdk-ruby/commit/617d7df30d5eec60d4c7af63a2954b6a945c4277))
+* broadly detect json family of content-type headers ([eb41428](https://github.com/anthropics/anthropic-sdk-ruby/commit/eb41428c85973c2e664e053415e2777f0d2f39a7))
+* **ci:** add timeout thresholds for CI jobs ([ea76f5c](https://github.com/anthropics/anthropic-sdk-ruby/commit/ea76f5c57dc556b094630150248b63a1ae7f431e))
+* **ci:** only use depot for staging repos ([213392b](https://github.com/anthropics/anthropic-sdk-ruby/commit/213392bb8c4b3765684a68de2a6aea1e59c0692b))
+* **ci:** run on more branches and use depot runners ([b85caa6](https://github.com/anthropics/anthropic-sdk-ruby/commit/b85caa6b9ccb6074a446f195d04b6e2eca07482d))
+* consistently use string in examples, even for enums ([2f6528e](https://github.com/anthropics/anthropic-sdk-ruby/commit/2f6528e4f6b4b6317e3f1903bd1381423f0aa8eb))
+* documentation improvements ([e479e74](https://github.com/anthropics/anthropic-sdk-ruby/commit/e479e7423fd7db99723af7e000af7915d9025128))
+* explicitly mark apis public under `Internal` module ([5adf74c](https://github.com/anthropics/anthropic-sdk-ruby/commit/5adf74c6032dd6bc304f936968d1f90391fc8654))
+* fix misc linting / minor issues ([753f93a](https://github.com/anthropics/anthropic-sdk-ruby/commit/753f93acc061764313883e12c3e2c21a65c89344))
+* **internal:** always run post-processing when formatting when syntax_tree ([6b66ae9](https://github.com/anthropics/anthropic-sdk-ruby/commit/6b66ae9b0b7bcb695a531ea37242b6ab666490b7))
+* **internal:** annotate request options with type aliases in sorbet ([78301c8](https://github.com/anthropics/anthropic-sdk-ruby/commit/78301c845d2f19ca67af13310443699801ca715b))
+* **internal:** codegen related update ([c8424fb](https://github.com/anthropics/anthropic-sdk-ruby/commit/c8424fb051fdd61fa9ea747acb3df264409b01e7))
+* **internal:** codegen related update ([ea9c02e](https://github.com/anthropics/anthropic-sdk-ruby/commit/ea9c02ed98b2db9103353d5a427daa2fe5531782))
+* **internal:** codegen related update ([e60bcc4](https://github.com/anthropics/anthropic-sdk-ruby/commit/e60bcc4b11cd93720300277d28302d86d8566762))
+* **internal:** codegen related update ([453af53](https://github.com/anthropics/anthropic-sdk-ruby/commit/453af530dea415d610566e2f8a88f317b5950c0f))
+* **internal:** contribute.md and contributor QoL improvements ([c48b418](https://github.com/anthropics/anthropic-sdk-ruby/commit/c48b418733b923bf8d470004df4a179aba989e96))
+* **internal:** improve response envelope unwrap functionality ([b807072](https://github.com/anthropics/anthropic-sdk-ruby/commit/b8070726b4d2b2d2612e4141a4c5122935715f76))
+* **internal:** loosen internal type restrictions ([7675f8e](https://github.com/anthropics/anthropic-sdk-ruby/commit/7675f8efad31278d372ac1d778fe542202706681))
+* **internal:** minor sync ([14829b1](https://github.com/anthropics/anthropic-sdk-ruby/commit/14829b1c97379325af6c716fd25eec7cf75eb7bc))
+* **internal:** minor touch ups on sdk internals ([3b4a873](https://github.com/anthropics/anthropic-sdk-ruby/commit/3b4a873177d9cdddcb6c07440619da007615c0bd))
+* **internal:** minor type annotation improvements ([e493aef](https://github.com/anthropics/anthropic-sdk-ruby/commit/e493aef841e1c86ef2954c24e029fd3719d5982d))
+* **internal:** mostly README touch ups ([b29f388](https://github.com/anthropics/anthropic-sdk-ruby/commit/b29f3887bd12df092cd8398ac6fb82b327c7d2b1))
+* **internal:** protect SSE parsing pipeline from broken UTF-8 characters ([74056ed](https://github.com/anthropics/anthropic-sdk-ruby/commit/74056edcb149d9237db1ef83f6afab46ce489689))
+* **internal:** remove unnecessary `rbi/lib` folder ([f238fa8](https://github.com/anthropics/anthropic-sdk-ruby/commit/f238fa8af1c36616dfb87ee102165183684898a9))
+* **internal:** version bump ([8478780](https://github.com/anthropics/anthropic-sdk-ruby/commit/8478780254d9ea6b489baccefe0b4a33c314e0c8))
+* make internal types pretty print ([99c01e4](https://github.com/anthropics/anthropic-sdk-ruby/commit/99c01e43cceeebd97875bdfa8551352076dfb69f))
+* make sorbet enums easier to read ([1909c6e](https://github.com/anthropics/anthropic-sdk-ruby/commit/1909c6ed7049fcf0d3b05a32318bd142f8116af7))
+* migrate away from deprecated `JSON#fast_generate` ([80308a9](https://github.com/anthropics/anthropic-sdk-ruby/commit/80308a9b311a0a2b9ee1311fdebce93e0aa0427e))
+* more accurate type annotations and aliases ([54c04df](https://github.com/anthropics/anthropic-sdk-ruby/commit/54c04df8f8f760aa9eed2466e1af1712a41f8c69))
+* move bedrock and vertex under anthropic/helpers ([#574](https://github.com/anthropics/anthropic-sdk-ruby/issues/574)) ([c2f3554](https://github.com/anthropics/anthropic-sdk-ruby/commit/c2f355403be66637d615ff9e8f2f79f27eb35af8))
+* re-export top level models under library namespace ([41a5161](https://github.com/anthropics/anthropic-sdk-ruby/commit/41a516134b3a9f4ac62d02a033369fee00162e36))
+* refine `#inspect` and `#to_s` for model classes ([de00260](https://github.com/anthropics/anthropic-sdk-ruby/commit/de002609060018c1f61ec5ed84cc497b6a0ef7bb))
+* remove Gemfile.lock during bootstrap ([7d671aa](https://github.com/anthropics/anthropic-sdk-ruby/commit/7d671aa814ff52569a8a372691a8964924a6e30c))
+* reorganize type aliases ([94c0258](https://github.com/anthropics/anthropic-sdk-ruby/commit/94c0258dc85df0094da63365021f1301c5700a7a))
+* revert ignoring Gemfile.lock ([47413aa](https://github.com/anthropics/anthropic-sdk-ruby/commit/47413aa7cae463b941b59f4b963b0d3d12eb60eb))
+* show truncated parameter docs in yard ([679c27b](https://github.com/anthropics/anthropic-sdk-ruby/commit/679c27b578b746360f92e778c48c9e9bb105174c))
+* simplify yard annotations by removing most `@!parse` directives ([5b23af5](https://github.com/anthropics/anthropic-sdk-ruby/commit/5b23af5a32f8317576e1f37e2685fead060956a6))
+* update README with recommended editor plugins ([0c706bb](https://github.com/anthropics/anthropic-sdk-ruby/commit/0c706bbcc23d6affe8223cdf7ec06cc75a241859))
+* use `@!method` instead of `@!parse` for virtual method type definitions ([2834dd6](https://github.com/anthropics/anthropic-sdk-ruby/commit/2834dd6f8bcb7ac7fbf2319c3ca948a8ecaa6c07))
+* validate request option coercion correctness ([cd89ec5](https://github.com/anthropics/anthropic-sdk-ruby/commit/cd89ec570f37d602b594de786863e6d146d98833))
+
+
+### Documentation
+
+* fix misplaced coming soon snippet in README.md ([6979aae](https://github.com/anthropics/anthropic-sdk-ruby/commit/6979aae6105c9a26557e756f3a62963c59f9c742))
+* illustrate environmental defaults for auth variables ([3f295d8](https://github.com/anthropics/anthropic-sdk-ruby/commit/3f295d8348e7e1c841b99911aa28e49a1b13a3cc))
+* **readme:** fix typo ([6effd14](https://github.com/anthropics/anthropic-sdk-ruby/commit/6effd148a3510980e40ecada7b05dd4b856ef5e4))
+* rewrite much of README.md for readability ([aaf7e8c](https://github.com/anthropics/anthropic-sdk-ruby/commit/aaf7e8c5ff69c1e209b7af078e3723418ec25b3c))
+* update documentation links to be more uniform ([6b95412](https://github.com/anthropics/anthropic-sdk-ruby/commit/6b95412c1193c99bd7f1c701929e76a021f6e39e))
+
 ## 0.1.0-beta.6 (2025-04-11)
 
 Full Changelog: [v0.1.0-beta.5...v0.1.0-beta.6](https://github.com/anthropics/anthropic-sdk-ruby/compare/v0.1.0-beta.5...v0.1.0-beta.6)

data/README.md

@@ -1,16 +1,19 @@
 # Anthropic Ruby API library
 
-The Anthropic Ruby library provides convenient access to the Anthropic REST API from any Ruby 3.1.0+ application.
+The Anthropic Ruby library provides convenient access to the Anthropic REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/anthropics/anthropic-sdk-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
 
 ## Documentation
 
-Documentation for released of this gem can be found [on RubyDoc](https://gemdocs.org/gems/anthropic-sdk-beta).
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/anthropic-sdk-beta).
 
-The underlying REST API documentation can be found on [docs.anthropic.com](https://docs.anthropic.com/claude/reference/).
+The REST API documentation can be found on [docs.anthropic.com](https://docs.anthropic.com/claude/reference/).
 
 ## Installation
+
 ℹ️ The `anthropic-sdk-beta` gem name is temporary. [@alexrudall](https://github.com/alexrudall) will be transitioning the [anthropic gem name](https://github.com/alexrudall/anthropic) to this repository. Here's the timeline:
+
 - Early April, 2025: This library is released under the `anthropic-sdk-beta` gem name. We'll be gathering feedback from the community.
+
 - Late April/early May: Bump the version `1.0`, and transition the `anthropic` gem name to this repository.
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
@@ -18,11 +21,17 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "anthropic-sdk-beta", "~> 0.1.0.pre.beta.6"
+gem "anthropic-sdk-beta", "~> 0.1.0.pre.beta.7"
 ```
 
 <!-- x-release-please-end -->
 
+## Feedback
+
+We're looking for as much feedback as possible while the SDK is in Beta. If you have recommendations, notice bugs, find things confusing, or anything else, create a github issue. Don't be shy -- we're very open to hearing any thoughts and musings you have!
+
+Feel free to make an issue for more substantial issues. For smaller issues or stream-of-thought, you can use the [pinned issue here](https://github.com/anthropics/anthropic-sdk-ruby/issues/85).
+
 ## Usage
 
 ```ruby
@@ -30,26 +39,35 @@ require "bundler/setup"
 require "anthropic"
 
 anthropic = Anthropic::Client.new(
-  api_key: "my-anthropic-api-key" # defaults to ENV["ANTHROPIC_API_KEY"]
+  api_key: ENV["ANTHROPIC_API_KEY"] # This is the default and can be omitted
 )
 
 message = anthropic.messages.create(
   max_tokens: 1024,
-  messages: [{
-    role: "user",
-    content: "Hello, Claude"
-  }],
-  model: "claude-3-5-sonnet-latest"
+  messages: [{role: "user", content: "Hello, Claude"}],
+  model: :"claude-3-7-sonnet-latest"
 )
 
 puts(message.content)
 ```
 
-### Feedback
+### Streaming
 
-We're looking for as much feedback as possible while the SDK is in Beta. If you have recommendations, notice bugs, find things confusing, or anything else, create a github issue. Don't be shy -- we're very open to hearing any thoughts and musings you have!
+We provide support for streaming responses using Server-Sent Events (SSE).
 
-Feel free to make an issue for more substantial issues. For smaller issues or stream-of-thought, you can use the [pinned issue here](https://github.com/anthropics/anthropic-sdk-ruby/issues/85).
+**coming soon**: `anthropic.messages.stream` will have [Python SDK](https://github.com/anthropics/anthropic-sdk-python?tab=readme-ov-file#streaming-helpers) style streaming response helpers.
+
+```ruby
+stream = anthropic.messages.stream_raw(
+  max_tokens: 1024,
+  messages: [{role: "user", content: "Hello, Claude"}],
+  model: :"claude-3-7-sonnet-latest"
+)
+
+stream.each do |message|
+  puts(message.type)
+end
+```
 
 ### Pagination
 
@@ -70,28 +88,16 @@ page.auto_paging_each do |batch|
 end
 ```
 
-### Streaming
-
-We provide support for streaming responses using Server Side Events (SSE).
-
-**coming soon**: `anthropic.messages.stream` will have [Python SDK](https://github.com/anthropics/anthropic-sdk-python?tab=readme-ov-file#streaming-helpers) style streaming response helpers.
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
 
 ```ruby
-stream = anthropic.messages.stream_raw(
-  max_tokens: 1024,
-  messages: [{
-    role: "user",
-    content: "Hello, Claude"
-  }],
-  model: "claude-3-5-sonnet-latest"
-)
-
-stream.each do |message|
-  puts(message.type)
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.data[0].id)
 end
 ```
 
-### Errors
+### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Anthropic::Errors::APIError` will be thrown:
 
@@ -99,18 +105,21 @@ When the library is unable to connect to the API, or if the API returns a non-su
 begin
   message = anthropic.messages.create(
     max_tokens: 1024,
-    messages: [{
-      role: "user",
-      content: "Hello, Claude"
-    }],
-    model: "claude-3-5-sonnet-latest"
+    messages: [{role: "user", content: "Hello, Claude"}],
+    model: :"claude-3-7-sonnet-latest"
   )
-rescue Anthropic::Errors::APIError => e
-  puts(e.status) # 400
+rescue Anthropic::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Anthropic::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Anthropic::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -143,22 +152,15 @@ anthropic = Anthropic::Client.new(
 # Or, configure per-request:
 anthropic.messages.create(
   max_tokens: 1024,
-  messages: [{
-    role: "user",
-    content: "Hello, Claude"
-  }],
-  model: "claude-3-5-sonnet-latest",
+  messages: [{role: "user", content: "Hello, Claude"}],
+  model: :"claude-3-7-sonnet-latest",
   request_options: {max_retries: 5}
 )
 ```
 
 ### Timeouts
 
-By default, requests will time out after 600 seconds.
-
-Timeouts are applied separately to the initial connection and the overall request time, so in some cases a request could wait 2\*timeout seconds before it fails.
-
-You can use the `timeout` option to configure or disable this:
+By default, requests will time out after 600 seconds. You can use the timeout option to configure or disable this:
 
 ```ruby
 # Configure the default for all requests:
@@ -169,72 +171,21 @@ anthropic = Anthropic::Client.new(
 # Or, configure per-request:
 anthropic.messages.create(
   max_tokens: 1024,
-  messages: [{
-    role: "user",
-    content: "Hello, Claude"
-  }],
-  model: "claude-3-5-sonnet-latest",
+  messages: [{role: "user", content: "Hello, Claude"}],
+  model: :"claude-3-7-sonnet-latest",
   request_options: {timeout: 5}
 )
 ```
 
-## LSP Support
-
-### Solargraph
-
-This library includes [Solargraph](https://solargraph.org) support for both auto completion and go to definition.
-
-```ruby
-gem "solargraph", group: :development
-```
-
-After Solargraph is installed, **you must populate its index** either via the provided editor command, or by running the following in your terminal:
-
-```sh
-bundle exec solargraph gems
-```
-
-Note: if you had installed the gem either using a `git:` or `github:` URL, or had vendored the gem using bundler, you will need to set up your [`.solargraph.yml`](https://solargraph.org/guides/configuration) to include the path to the gem's `lib` directory.
-
-```yaml
-include:
-  - 'vendor/bundle/ruby/*/gems/anthropic-sdk-beta-*/lib/**/*.rb'
-```
-
-Otherwise Solargraph will not be able to provide type information or auto-completion for any non-indexed libraries.
-
-### Sorbet
-
-This library is written with [Sorbet type definitions](https://sorbet.org/docs/rbi). However, there is no runtime dependency on the `sorbet-runtime`.
-
-What this means is that while you can use Sorbet to type check your code statically, and benefit from the [Sorbet Language Server](https://sorbet.org/docs/lsp) in your editor, there is no runtime type checking and execution overhead from Sorbet itself.
-
-Due to limitations with the Sorbet type system, where a method otherwise can take an instance of `Anthropic::BaseModel` class, you will need to use the `**` splat operator to pass the arguments:
-
-Please follow Sorbet's [setup guides](https://sorbet.org/docs/adopting) for best experience.
-
-```ruby
-params = Anthropic::Models::MessageCreateParams.new(
-    max_tokens: 1024,
-    messages: [Anthropic::Models::MessageParam.new(role: :user, content: "hello")],
-    model: "claude-3-5-sonnet-latest"
-  )
-
-anthropic.messages.create(**params)
-```
-
-Note: **This library emits an intentional warning under the [`tapioca` toolchain](https://github.com/Shopify/tapioca)**. This is normal, and does not impact functionality.
-
-### Ruby LSP
-
-The Ruby LSP has [best effort support](https://shopify.github.io/ruby-lsp/#guessed-types) for inferring type information from Ruby code, and as such it may not always be able to provide accurate type information.
+On timeout, `Anthropic::Errors::APITimeoutError` is raised.
 
+Note that requests that time out are retried by default.
 
 ## AWS Bedrock
 
 This library also provides support for the [Anthropic Bedrock API](https://aws.amazon.com/bedrock/claude/) if you install this library with the `aws-sdk-bedrockruntime` gem.
 
-You can then instantiate a separate `Anthropic::Bedrock::Client` class, and use AWS's standard guide for configuring credentials (see [the aws-sdk-ruby gem README](https://github.com/aws/aws-sdk-ruby?tab=readme-ov-file#configuration) or [AWS Documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html#credchain)). It has the same API as the base `Anthropic::Client` class.
+You can then instantiate a separate `Anthropic::BedrockClient` class, and use AWS's standard guide for configuring credentials (see [the aws-sdk-ruby gem README](https://github.com/aws/aws-sdk-ruby?tab=readme-ov-file#configuration) or [AWS Documentation](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html#credchain)). It has the same API as the base `Anthropic::Client` class.
 
 Note that the model ID required is different for Bedrock models, and, depending on the model you want to use, you will need to use either the AWS's model ID for Anthropic models -- which can be found in [AWS's Bedrock model catalog](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html) -- or an inference profile id (e.g. `us.anthropic.claude-3-5-haiku-20241022-v1:0` for Claude 3.5 Haiku).
 
@@ -242,7 +193,7 @@ Note that the model ID required is different for Bedrock models, and, depending
 require "bundler/setup"
 require "anthropic"
 
-anthropic = Anthropic::Bedrock::Client.new
+anthropic = Anthropic::BedrockClient.new
 
 message = anthropic.messages.create(
   max_tokens: 1024,
@@ -255,7 +206,7 @@ message = anthropic.messages.create(
   model: "anthropic.claude-3-5-sonnet-20241022-v2:0"
 )
 
-puts message
+puts(message)
 ```
 
 For more examples see [`examples/bedrock`](examples/bedrock).
@@ -264,13 +215,13 @@ For more examples see [`examples/bedrock`](examples/bedrock).
 
 This library also provides support for the [Anthropic Vertex API](https://cloud.google.com/vertex-ai?hl=en) if you install this library with the `googleauth` gem.
 
-You can then import and instantiate a separate `Anthropic::Vertex::Client` class, and use Google's guide for configuring [Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc). It has the same API as the base `Anthropic::Client` class.
+You can then import and instantiate a separate `Anthropic::VertexClient` class, and use Google's guide for configuring [Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc). It has the same API as the base `Anthropic::Client` class.
 
 ```ruby
 require "bundler/setup"
 require "anthropic"
 
-anthropic = Anthropic::Vertex::Client.new(region: "us-east5", project_id: "my-project-id")
+anthropic = Anthropic::VertexClient.new(region: "us-east5", project_id: "my-project-id")
 
 message = anthropic.messages.create(
   max_tokens: 1024,
@@ -283,46 +234,135 @@ message = anthropic.messages.create(
   model: "claude-3-7-sonnet@20250219"
 )
 
-puts message
+puts(message)
 ```
 
 For more examples see [`examples/vertex`](examples/vertex).
 
-## Advanced
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `Anthropic::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
 
-### Making custom/undocumented requests
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
 
-This library is typed for convenient access to the documented API.
+3. Both instances and the classes themselves can be pretty-printed.
 
-If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+message =
+  anthropic.messages.create(
+    max_tokens: 1024,
+    messages: [{role: "user", content: "Hello, Claude"}],
+    model: :"claude-3-7-sonnet-latest",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(message[:my_undocumented_property])
+```
 
 #### Undocumented request params
 
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a requests as seen in examples above.
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
 
 #### Undocumented endpoints
 
-To make requests to undocumented endpoints, you can make requests using `client.request`. Options on the client will be respected (such as retries) when making this request.
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
 
 ```ruby
 response = client.request(
-    method: :post,
-    path: '/undocumented/endpoint',
-    query: {"dog": "woof"},
-    headers: {"useful-header": "interesting-value"},
-    body: {"he": "llo"},
-  )
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
 ```
 
-### Concurrency & Connection Pooling
+### Concurrency & connection pooling
+
+The `Anthropic::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
 
-The `Anthropic::Client` instances are thread-safe, and should be re-used across multiple threads. By default, each `Client` have their own HTTP connection pool, with a maximum number of connections equal to thread count.
+Each instance of `Anthropic::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
-When the maximum number of connections has been checked out from the connection pool, the `Client` will wait for an in use connection to become available. The queue time for this mechanism is accounted for by the per-request timeout.
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
 
 Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
 
-Currently, `Anthropic::Client` instances are only fork-safe if there are no in-flight HTTP requests.
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+anthropic.messages.create(
+  max_tokens: 1024,
+  messages: [Anthropic::MessageParam.new(role: "user", content: "Hello, Claude")],
+  model: :"claude-3-7-sonnet-latest"
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+anthropic.messages.create(
+  max_tokens: 1024,
+  messages: [{role: "user", content: "Hello, Claude"}],
+  model: :"claude-3-7-sonnet-latest"
+)
+
+# You can also splat a full Params class:
+params = Anthropic::MessageCreateParams.new(
+  max_tokens: 1024,
+  messages: [Anthropic::MessageParam.new(role: "user", content: "Hello, Claude")],
+  model: :"claude-3-7-sonnet-latest"
+)
+anthropic.messages.create(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :"image/jpeg"
+puts(Anthropic::Base64ImageSource::MediaType::IMAGE_JPEG)
+
+# Revealed type: `T.all(Anthropic::Base64ImageSource::MediaType, Symbol)`
+T.reveal_type(Anthropic::Base64ImageSource::MediaType::IMAGE_JPEG)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+Anthropic::Base64ImageSource.new(
+  media_type: Anthropic::Base64ImageSource::MediaType::IMAGE_JPEG,
+  # …
+)
+
+Anthropic::Base64ImageSource.new(
+  media_type: :"image/jpeg",
+  # …
+)
+```
 
 ## Versioning
 
@@ -332,7 +372,12 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.1.0 or higher.
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/anthropics/anthropic-sdk-ruby/tree/main/CONTRIBUTING.md).
 
 ## Acknowledgements
+
 Thank you [@alexrudall](https://github.com/alexrudall) for giving feedback, donating the `anthropic` Ruby Gem name, and paving the way by building the first Anthropic Ruby SDK.

data/lib/anthropic/bedrock.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Anthropic
+  BedrockClient = Anthropic::Helpers::Bedrock::Client
+end

data/lib/anthropic/client.rb

@@ -62,7 +62,8 @@ module Anthropic
     #
     # @param auth_token [String, nil] Defaults to `ENV["ANTHROPIC_AUTH_TOKEN"]`
     #
-    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["ANTHROPIC_BASE_URL"]`
     #
     # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
     #
@@ -74,11 +75,11 @@ module Anthropic
     def initialize(
       api_key: ENV["ANTHROPIC_API_KEY"],
       auth_token: ENV["ANTHROPIC_AUTH_TOKEN"],
-      base_url: nil,
-      max_retries: DEFAULT_MAX_RETRIES,
-      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
-      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
-      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+      base_url: ENV["ANTHROPIC_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
     )
       base_url ||= "https://api.anthropic.com"
 

data/lib/anthropic/errors.rb

@@ -3,9 +3,9 @@
 module Anthropic
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < Anthropic::Errors::Error
@@ -40,13 +40,13 @@ module Anthropic
     end
 
     class APIConnectionError < Anthropic::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #
@@ -99,7 +99,7 @@ module Anthropic
       # @param response [nil]
       # @param message [String, nil]
       #
-      # @return [Anthropic::Errors::APIStatusError]
+      # @return [self]
       def self.for(url:, status:, body:, request:, response:, message: nil)
         kwargs = {
           url: url,