anthropic-rb 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e3bf7350209fe6270479e8bc20f1418975257b6cfb1beb2d67547eec8d4e168
-  data.tar.gz: 38c41a98c7095491ade15304025a8d6febb35ec10d758a7a0b725ad23a4e19e7
+  metadata.gz: b5e066105f3157621c27e2f974ed43bde9f14e6e55187d1d7a4f095b79a5a1ba
+  data.tar.gz: f32d479f7ec06c29a0347f69084a4378a64d69233d78ed280f5a1c924e15d708
 SHA512:
-  metadata.gz: a69135f37ef25151067595106f6955c4fea146d4a95eb4093925d4a8eb26f9be46b4dcf4920e3a0cc8e55b462690a23ee929ab93468b358d51169aea90ed9f3d
-  data.tar.gz: 0405140a9574e4e4afa23504714f25687ed7a47acb5a02adec25e4b5e7ab6007ab3d160835e82a46795dba63f91b83801ba671db32cc8f5e47098e86278d9c06
+  metadata.gz: 90040c86504a3dfd28e0093d1b8525252387f4e978271908aa158d1cffe10a3dd5766aadc243bc31f45ca6dd38ecf1259d009b2da9f2f78670fcc114c76574a3
+  data.tar.gz: 8ca46c62fe204b3b2403cce1267b6661f43c52159c8d31877b9d2522be604427996eedcbac67ba22a1b6df703259ededd98ea2b86d49755d7aa057835458321c

data/.reek.yml

@@ -5,3 +5,9 @@ detectors:
   TooManyStatements:
     exclude:
       - 'Anthropic::Client#self.post'
+  BooleanParameter:
+    exclude:
+      - 'Anthropic::Messages#initialize'
+  DuplicateMethodCall:
+    exclude:
+      - 'Anthropic::Messages#create'

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## [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
+
+- Add support for sending headers to client.
+- Add support for beta Messages API.
+
 ## [0.2.5] - 2023-12-27
 
 ### Fixed
@@ -40,7 +57,9 @@
 
 - Initial release
 
-[Unreleased]: https://github.com/dickdavis/anthropic-rb/compare/v0.2.5...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
 [0.2.2]: https://github.com/dickdavis/anthropic-rb/compare/v0.2.1...v0.2.2

data/README.md

@@ -6,27 +6,90 @@ The goal of this project is feature parity with Anthropic's Python SDK until an
 
 ## Usage
 
-anthropic-rb will default to the value of the `ANTHROPIC_API_KEY` environment variable. However, you may initialize the library with your API key:
+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'
 end
 ```
 
-You can also specify an API version to use by setting the `ANTHROPIC_API_VERSION` environment variable or during initialization:
+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'
 end
 ```
 
-The default API version is `2023-06-01`.
+### Messages API
+
+You can send a request to the Messages API.
+
+```ruby
+Anthropic.messages.create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}])
+
+# Output =>
+# {
+#   id: "msg_013ePdwEkb4RMC1hCE61Hbm8",
+#   type: "message",
+#   role: "assistant",
+#   content: [{type: "text", text: "Hello! Not much up with me, just chatting. How about you?"}],
+#   model: "claude-2.1",
+#   stop_reason: "end_turn",
+#   stop_sequence: nil
+# }
+```
+
+Alternatively, you can stream the response:
+
+```ruby
+Anthropic.messages.create(model: 'claude-2.1', max_tokens: 200, messages: [{role: 'user', content: 'Yo what up?'}], stream: true) do |event|
+  puts event
+end
+
+# Output =>
+# { type: 'message_start', message: { id: 'msg_012pkeozZynwyNvSagwL7kMw', type: 'message', role: 'assistant', content: [], model: 'claude-2.1', stop_reason: nil, stop_sequence: nil } }
+# { type: 'content_block_start', index: 0, content_block: { type: 'text', text: '' } }
+# { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: 'Hello' } }
+# { type: 'content_block_delta', index: 0, delta: { type: 'text_delta', text: '.' } }
+# { type: 'content_block_stop', index: 0 }
+# { type: 'message_delta', delta: { stop_reason: 'end_turn', stop_sequence: nil } }
+# { 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:
 
@@ -55,21 +118,21 @@ Anthropic.completions.create(model: 'claude-2', max_tokens_to_sample: 200, promp
 end
 
 # Output =>
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" Hello", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"!", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" Not", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" much", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>",", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" just", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" chatting", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" with", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" people", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>".", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" How", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" about", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" you", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"?", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
-# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"", :stop_reason=>"stop_sequence", :model=>"claude-2.1", :stop=>"\n\nHuman:", :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' Hello', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: '!', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' Not', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' much', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ',', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' just', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' chatting', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' with', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' people', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: '.', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' How', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' about', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: ' you', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: '?', stop_reason: nil, model: 'claude-2.1', stop: nil, log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
+# { type: 'completion', id: 'compl_01G6cEfdZtLEEJVRzwUShiDY', completion: '', stop_reason: 'stop_sequence', model: 'claude-2.1', stop: "\n\nHuman:", log_id: 'compl_01G6cEfdZtLEEJVRzwUShiDY' }
 ```
 
 ## Installation

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/client.rb

@@ -32,13 +32,13 @@ module Anthropic
   # Provides a client for sending HTTP requests.
   class Client
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
-    def self.post(url, data)
+    def self.post(url, data, headers = {})
       response = HTTPX.with(
         headers: {
           'Content-Type' => 'application/json',
           'x-api-key' => Anthropic.api_key,
           'anthropic-version' => Anthropic.api_version
-        }
+        }.merge(headers)
       ).post(url, json: data)
 
       response_body = JSON.parse(response.body, symbolize_names: true)
@@ -65,13 +65,13 @@ module Anthropic
       end
     end
 
-    def self.post_as_stream(url, data)
+    def self.post_as_stream(url, data, headers = {})
       response = HTTPX.plugin(:stream).with(
         headers: {
           'Content-Type' => 'application/json',
           'x-api-key' => Anthropic.api_key,
           'anthropic-version' => Anthropic.api_version
-        }
+        }.merge(headers)
       ).post(url, json: data, stream: true)
 
       response.each_line do |line|

data/lib/anthropic/messages.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Anthropic
+  ##
+  # Provides bindings for the Anthropic messages API
+  class Messages
+    # 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',
+      required: %w[model messages max_tokens],
+      properties: {
+        model: { type: 'string' },
+        messages: { type: 'array' },
+        max_tokens: { type: 'integer' },
+        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' },
+        stream: { type: 'boolean' }
+      },
+      additionalProperties: false
+    }.freeze
+
+    def initialize(beta: false)
+      @beta = beta
+    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, &)
+    rescue JSON::Schema::ValidationError => error
+      raise ArgumentError, error.message
+    end
+
+    private
+
+    attr_reader :beta
+
+    def schema_for_api_version
+      api_version = Anthropic.api_version
+      case api_version
+      when '2023-06-01'
+        V1_SCHEMA
+      else
+        raise UnsupportedApiVersionError, "Unsupported API version: #{api_version}"
+      end
+    end
+
+    def additional_headers
+      return {} unless beta
+
+      { '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.2.5'
+  VERSION = '0.4.0'
 end

data/lib/anthropic.rb

@@ -6,6 +6,7 @@ require 'json-schema'
 
 require_relative 'anthropic/client'
 require_relative 'anthropic/completions'
+require_relative 'anthropic/messages'
 require_relative 'anthropic/version'
 
 ##
@@ -43,4 +44,8 @@ module Anthropic
   def self.completions
     Completions.new
   end
+
+  def self.messages(...)
+    Messages.new(...)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anthropic-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  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,9 +54,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- anthropic-rb.gemspec
 - lib/anthropic.rb
 - lib/anthropic/client.rb
 - lib/anthropic/completions.rb
+- lib/anthropic/messages.rb
 - lib/anthropic/version.rb
 - sig/anthropic/rb.rbs
 homepage: https://github.com/dickdavis/anthropic-rb