anthropic-rb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 137b1e285afd97d1ec45ba94685dfcb17afd4388dbd43dbad200ef61228952bd
-  data.tar.gz: 465bc7914a25c1f438539364de3fe753f379879273ffafac0818305db60d782c
+  metadata.gz: b5e066105f3157621c27e2f974ed43bde9f14e6e55187d1d7a4f095b79a5a1ba
+  data.tar.gz: f32d479f7ec06c29a0347f69084a4378a64d69233d78ed280f5a1c924e15d708
 SHA512:
-  metadata.gz: 34e45517ffa6f2b35a550f8ff1827618b1a01068cc685f8e7980ea893025cd3811609f80cf2ce5c3d199507252701ad4efcc4ddb7cf2d462b996b5c9aa3229f3
-  data.tar.gz: 2eddc00d9f8c86c45187a332a93e1d218f04af1eaf8cac45ccdcc767dba4e3c9217c17b80753b1c53d64c2b80aa2fa2c8940af1fe56a0c630766ab8e2f4ef0d5
+  metadata.gz: 90040c86504a3dfd28e0093d1b8525252387f4e978271908aa158d1cffe10a3dd5766aadc243bc31f45ca6dd38ecf1259d009b2da9f2f78670fcc114c76574a3
+  data.tar.gz: 8ca46c62fe204b3b2403cce1267b6661f43c52159c8d31877b9d2522be604427996eedcbac67ba22a1b6df703259ededd98ea2b86d49755d7aa057835458321c

data/.reek.yml

@@ -8,3 +8,6 @@ detectors:
   BooleanParameter:
     exclude:
       - 'Anthropic::Messages#initialize'
+  DuplicateMethodCall:
+    exclude:
+      - 'Anthropic::Messages#create'

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [0.4.0] - 2024-04-20
+
+### Added
+
+- Add support for the tools beta.
+
+### Updated
+
+- Remove beta header for Messages API as the API is no longer in beta.
+
 ## [0.3.0] - 2023-12-28
 
 ### Added
@@ -47,7 +57,8 @@
 
 - Initial release
 
-[Unreleased]: https://github.com/dickdavis/anthropic-rb/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/dickdavis/anthropic-rb/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/dickdavis/anthropic-rb/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/dickdavis/anthropic-rb/compare/v0.2.5...v0.3.0
 [0.2.5]: https://github.com/dickdavis/anthropic-rb/compare/v0.2.3...v0.2.5
 [0.2.3]: https://github.com/dickdavis/anthropic-rb/compare/v0.2.2...v0.2.3

data/README.md

@@ -9,7 +9,7 @@ The goal of this project is feature parity with Anthropic's Python SDK until an
 anthropic-rb will default to the value of the `ANTHROPIC_API_KEY` environment variable. However, you may initialize the library with your API key. You must set your API key before using the library.
 
 ```ruby
-require 'anthropic-rb'
+require 'anthropic'
 
 Anthropic.setup do |config|
   config.api_key = 'YOUR_API_KEY'
@@ -19,7 +19,7 @@ end
 You can also specify an API version to use by setting the `ANTHROPIC_API_VERSION` environment variable or during initialization. This is optional; if not set, the library will default to `2023-06-01`.
 
 ```ruby
-require 'anthropic-rb'
+require 'anthropic'
 
 Anthropic.setup do |config|
   config.api_version = '2023-06-01'
@@ -28,10 +28,10 @@ end
 
 ### Messages API
 
-You can send a request to the Messages API. The Messages API is currently in beta; as such, you'll need to pass the `beta` flag when calling the API to ensure the correct header is included.
+You can send a request to the Messages API.
 
 ```ruby
-Anthropic.messages(beta: true).create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}])
+Anthropic.messages.create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}])
 
 # Output =>
 # {
@@ -48,7 +48,7 @@ Anthropic.messages(beta: true).create(model: 'claude-2.1', max_tokens: 200, mess
 Alternatively, you can stream the response:
 
 ```ruby
-Anthropic.messages(beta: true).create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}], stream: true) do |event|
+Anthropic.messages.create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}], stream: true) do |event|
   puts event
 end
 
@@ -62,6 +62,33 @@ end
 # { type: 'message_stop' }
 ```
 
+You can also experiment with the new tools beta by passing the `beta` flag when calling the API. This will ensure each request includes the correct beta header.
+
+```ruby
+tools = [
+  {
+    name: 'get_weather',
+    description: 'Get the current weather in a given location',
+    input_schema: {
+      type: 'object',
+      properties: {
+        location: { type: 'string' }
+      },
+      required: ['location']
+    }
+  }
+]
+
+Anthropic.messages(beta: true).create(
+  model: 'claude-3-opus-20240229',
+  max_tokens: 200,
+  tools:,
+  messages: [{role: 'user', content: 'What is the weather like in Nashville?'}]
+)
+```
+
+Streaming is currently not supported by the tools beta. You can find out more information about tools in the [documentation](https://docs.anthropic.com/claude/docs/tool-use).
+
 ### Completions API
 
 To make a request to the Completions API:

data/anthropic-rb.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/anthropic/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'anthropic-rb'
+  spec.version = Anthropic::VERSION
+  spec.authors = ['Dick Davis']
+  spec.email = ['dick@hey.com']
+
+  spec.summary = 'Ruby bindings for the Anthropic API'
+  spec.homepage = 'https://github.com/dickdavis/anthropic-rb'
+  spec.license = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/dickdavis/anthropic-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/dickdavis/anthropic-rb/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ spec/ .git .github/ Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.required_ruby_version = '>= 3.1'
+  spec.add_dependency 'httpx', '>= 1.1.5'
+  spec.add_dependency 'json-schema', '>= 4.1.1'
+end

data/lib/anthropic/messages.rb

@@ -7,6 +7,9 @@ module Anthropic
     # Error for when the API version is not supported.
     class UnsupportedApiVersionError < StandardError; end
 
+    # Error for when a beta feature is not used correctly
+    class UnsupportedBetaOptionError < StandardError; end
+
     ENDPOINT = 'https://api.anthropic.com/v1/messages'
     V1_SCHEMA = {
       type: 'object',
@@ -18,6 +21,14 @@ module Anthropic
         system: { type: 'string' },
         stop_sequences: { type: 'array', items: { type: 'string' } },
         temperature: { type: 'number' },
+        tools: {
+          type: 'array',
+          items: {
+            name: { type: 'string' },
+            description: { type: 'string' },
+            input_schema: { type: 'object' }
+          }
+        },
         top_k: { type: 'integer' },
         top_p: { type: 'number' },
         metadata: { type: 'object' },
@@ -31,7 +42,10 @@ module Anthropic
     end
 
     def create(**params, &)
+      raise UnsupportedBetaOptionError, 'Tool use is not yet supported in streaming mode' if params[:stream] && beta
+
       JSON::Validator.validate!(schema_for_api_version, params)
+
       return Anthropic::Client.post(ENDPOINT, params, additional_headers) unless params[:stream]
 
       Anthropic::Client.post_as_stream(ENDPOINT, params, additional_headers, &)
@@ -56,7 +70,7 @@ module Anthropic
     def additional_headers
       return {} unless beta
 
-      { 'anthropic-beta' => 'messages-2023-12-15' }
+      { 'anthropic-beta' => 'tools-2024-04-04' }
     end
   end
 end

data/lib/anthropic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anthropic
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anthropic-rb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dick Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-28 00:00:00.000000000 Z
+date: 2024-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -54,6 +54,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- anthropic-rb.gemspec
 - lib/anthropic.rb
 - lib/anthropic/client.rb
 - lib/anthropic/completions.rb