claude-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acba80183a9f1ade551f7c6b948f24b02e0f3d1eedf784a50715c48e4bfbec78
-  data.tar.gz: 35f49c5e0f3e51da700808a48ecd017dbe5251ab0eaaddccab7439a82a5947fb
+  metadata.gz: 04c0cdb7e7e035455287513cac3b7576c5a303ded39a41c1fd11b3153d96c318
+  data.tar.gz: 501fab83c266f518ddeb9d5851daab241eb4a2fc8474e432d1853f19fc66d21e
 SHA512:
-  metadata.gz: af50a4ec445fe61a69a53e2a5408924fccdd5a229caf5b7d8ee1e6216760ac29d72be36eff6f7e4e7f78150020fa2dbd0807a27af6e414e81d056e613c168012
-  data.tar.gz: 4540eb9f231f5a366c230e570beeffaa5d0082b90b84dc85a67ad5c33dd94114a6b21b5c017545d815c37e12fb93d1c8a6b2cdf818109abf0ad8c86e00f3b77f
+  metadata.gz: 141041c2b8d7c724bb0ff1e8679ff2c26d9f1a3eb3b9df6224f2b4f6e02e106a4a42ba7a1f26b806597643aab7b575d53dbe6bc60da2aca3fc5f493433132932
+  data.tar.gz: 6317870de2bbea4a224015ee7c2e0555bcb8fc6f2c4c8be173643fac99cef55170795192cddc6add65f65c052af0ba7d3e1758bb5a257e65f0eb82c1fa0d835b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.4.0] - 2024-07-09
+- Refactored model constants into a separate Model module
+- Support custom endpoints
+- Allow timeout to be specified
+
+## [0.3.1] - 2024-06-29
+- Updated documentation
+ 
 ## [0.3.0] - 2024-06-29
 
 - Added constants for the main Claude models

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    claude-ruby (0.2.1)
+    claude-ruby (0.3.1)
       httparty
 
 GEM

data/README.md

@@ -83,7 +83,7 @@ response['content'][0]['text']
 messages = [
   {
     role: "user",
-    content: "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+    content: "In which year was the first ever rugby world cup? (A) 1983 (B) 1987 (C) 1991"
   },
   {
     role: "assistant",
@@ -130,6 +130,94 @@ messages = [
 response = claude_client.messages(messages, { system: system })
 ```
 
+## Models
+
+If you don't specify a model, then the gem will use the latest version of Claude Sonnet by default, which is currently ```claude-3-5-sonnet-20240620```
+
+You can use a different model by specifying it as a parameter in the messages call:
+
+```ruby
+response = claude_client.messages(messages, { model: 'claude-3-haiku-20240307' })
+````
+
+There are some constants defined so you can choose an appropriate model for your use-case and not have to worry about updating it when new Claude models are released:
+
+```ruby
+Claude::Model::CLAUDE_OPUS_LATEST
+Claude::Model::CLAUDE_SONNET_LATEST
+Claude::Model::CLAUDE_HAIKU_LATEST
+
+Claude::Model::CLAUDE_FASTEST
+Claude::Model::CLAUDE_CHEAPEST
+Claude::Model::CLAUDE_BALANCED
+Claude::Model::CLAUDE_SMARTEST
+````
+
+Example usage:
+
+```ruby
+response = claude_client.messages(messages, { model: Claude::Model::CLAUDE_CHEAPEST })
+````
+
+## Timeout
+
+You can optionally set a timeout (integer) which will determine the maximum number of seconds to wait for the API call to complete.
+
+There are two ways to do this:
+
+1. Set a default timeout when instantiating the claude_client \
+This timeout value will be used for all API calls unless overridden.
+
+```ruby
+claude_client = Claude::Client.new(api_key, timeout: 10)
+```
+
+2. Pass in a timeout value as a parameter when calling the messages method. \
+This timeout value will be used only for that specific messages request. 
+
+```ruby
+response = claude_client.messages(messages, { timeout: 10 })
+```
+
+
+## Parameters
+
+You can pass in any of the following parameters, which will be included in the Anthropic API call: 
+
+```ruby
+model
+system
+max_tokens
+metadata
+stop_sequences
+stream
+temperature
+top_p
+top_k
+
+timeout (*)
+````
+(*) timeout is used for the HTTP request but not passed with the API data
+
+Example:
+
+```ruby
+response = claude_client.messages(messages, 
+                                  { model: Claude::Model::CLAUDE_SMARTEST,
+                                    max_tokens: 500,
+                                    temperature: 0.1 })
+````
+
+## Custom endpoint
+
+By default claude-ruby will use the latest official Anthropic API endpoint at the time that the gem version is released.
+
+You can optionally optionally override this - e.g. for testing, or for using a beta endpoint.
+
+```ruby
+claude_client = Claude::Client.new(api_key, endpoint: 'you-custom-endpoint')
+```
+
 ## Vision
 
 It's possible to pass an image to the Anthropic API and have Claude describe the image for you.

data/lib/claude/client.rb

@@ -2,36 +2,53 @@ require 'httparty'
 require 'json'
 
 module Claude
-  class Client
-    MODEL_CLAUDE_3_OPUS_20240229 = 'claude-3-opus-20240229'
+  module Model
+    CLAUDE_3_OPUS_20240229 = 'claude-3-opus-20240229'
 
-    MODEL_CLAUDE_3_SONNET_20240229 = 'claude-3-sonnet-20240229'
-    MODEL_CLAUDE_3_5_SONNET_20240620 = 'claude-3-5-sonnet-20240620'
+    CLAUDE_3_SONNET_20240229 = 'claude-3-sonnet-20240229'
+    CLAUDE_3_5_SONNET_20240620 = 'claude-3-5-sonnet-20240620'
 
-    MODEL_CLAUDE_3_HAIKU_20240307 = 'claude-3-haiku-20240307'
+    CLAUDE_3_HAIKU_20240307 = 'claude-3-haiku-20240307'
 
-    MODEL_CLAUDE_OPUS_LATEST = MODEL_CLAUDE_3_OPUS_20240229
-    MODEL_CLAUDE_SONNET_LATEST = MODEL_CLAUDE_3_5_SONNET_20240620
-    MODEL_CLAUDE_HAIKU_LATEST = MODEL_CLAUDE_3_HAIKU_20240307
+    CLAUDE_OPUS_LATEST = CLAUDE_3_OPUS_20240229
+    CLAUDE_SONNET_LATEST = CLAUDE_3_5_SONNET_20240620
+    CLAUDE_HAIKU_LATEST = CLAUDE_3_HAIKU_20240307
 
-    MODEL_CLAUDE_FASTEST = MODEL_CLAUDE_HAIKU_LATEST
-    MODEL_CLAUDE_CHEAPEST = MODEL_CLAUDE_HAIKU_LATEST
-    MODEL_CLAUDE_BALANCED = MODEL_CLAUDE_SONNET_LATEST
-    MODEL_CLAUDE_SMARTEST = MODEL_CLAUDE_3_5_SONNET_20240620
+    CLAUDE_FASTEST = CLAUDE_HAIKU_LATEST
+    CLAUDE_CHEAPEST = CLAUDE_HAIKU_LATEST
+    CLAUDE_BALANCED = CLAUDE_SONNET_LATEST
+    CLAUDE_SMARTEST = CLAUDE_3_5_SONNET_20240620
 
-    MODEL_CLAUDE_DEFAULT = MODEL_CLAUDE_SONNET_LATEST
+    CLAUDE_DEFAULT = CLAUDE_SONNET_LATEST
+  end
 
-    def initialize(api_key)
+  class Client
+
+    def initialize(api_key, endpoint: nil, timeout: 60)
       @api_key = api_key
-      @endpoint = 'https://api.anthropic.com/v1'
+      @endpoint = endpoint || anthropic_endpoint
+      @timeout = timeout
+
+      raise(ArgumentError, "api_key is required") if api_key.nil?
+    end
+
+    def version
+      'v1'
+    end
+
+    def anthropic_endpoint
+      "https://api.anthropic.com/#{version}"
+    end
+
+    def messages_endpoint
+      "#{anthropic_endpoint}/messages"
     end
 
     def messages(messages, params = {})
-      model = params[:model] || MODEL_CLAUDE_DEFAULT
+      model = params[:model] || Model::CLAUDE_DEFAULT
       max_tokens = params[:max_tokens] || 4096
       system = params[:system] || "You are a helpful assistant."
-
-      url = "#{@endpoint}/messages"
+      timeout = params[:timeout] || @timeout
 
       data = {
         model: model,
@@ -46,7 +63,7 @@ module Claude
         top_k: params[:top_k],
       }.compact
 
-      post_api(url, data)
+      post_api(messages_endpoint, data, timeout)
     end
 
     def headers
@@ -70,16 +87,30 @@ module Claude
       response['content'][0]['text']
     end
 
+    # for backwards compatibility with version 0.3.1
+    def self.const_missing(const_name)
+      if const_name.to_s.match(/^MODEL_(CLAUDE_.+)$/)
+        new_const_name = $1
+        if Claude::Model.constants.include?(new_const_name.to_sym)
+          warn "[DEPRECATION] `#{const_name}` is deprecated. Please use `Claude::Model::#{new_const_name}` instead."
+          Claude::Model.const_get(new_const_name)
+        else
+          super
+        end
+      else
+        super
+      end
+    end
+
     private
 
-    def post_api(url, data)
-      response = HTTParty.post(url, body: data.to_json, headers: headers)
+    def post_api(url, data, timeout)
+      response = HTTParty.post(url, body: data.to_json, headers: headers, timeout: timeout)
       if response && response['type'] == 'error'
         raise StandardError.new("#{response['error']['type']}: #{response['error']['message']}")
       else
         JSON.parse(response.body)
       end
     end
-
   end
 end

data/lib/claude/ruby/version.rb

@@ -2,6 +2,6 @@
 
 module Claude
   module Ruby
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/sig/claude/client.rbs

@@ -0,0 +1,7 @@
+module Claude
+  class Client
+    @api_key: String
+    @endpoint: String
+    @timeout: Integer
+  end
+end

data/sig/claude/ruby.rbs

@@ -1,6 +1,5 @@
 module Claude
   module Ruby
     VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: claude-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Web Ventures Ltd
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,8 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Unofficial ruby SDK for interacting with the Anthropic API, for generating
-  and streaming messages through Claude.
+description: Ruby SDK for interacting with the Anthropic API, for generating and streaming
+  messages through Claude AI.
 email:
 - webven@mailgab.com
 executables: []
@@ -38,10 +38,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- claude-ruby-0.2.1.gem
 - lib/claude/client.rb
 - lib/claude/ruby.rb
 - lib/claude/ruby/version.rb
+- sig/claude/client.rbs
 - sig/claude/ruby.rbs
 homepage: https://github.com/webventures/claude-ruby.git
 licenses: