claude-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46caaa462835cb7b1cfff4ca13ad00a59236873211a96871d79c7c420f3945c3
-  data.tar.gz: e945c6ce9c036eccb7733c361fcc842b4143496577a21e2c3ff9ce055bd15873
+  metadata.gz: acba80183a9f1ade551f7c6b948f24b02e0f3d1eedf784a50715c48e4bfbec78
+  data.tar.gz: 35f49c5e0f3e51da700808a48ecd017dbe5251ab0eaaddccab7439a82a5947fb
 SHA512:
-  metadata.gz: be6c578a3b72aa328c9cf6416a7e8ac63d734202fc790797f819ea993e35daf09c63cee950c6351d2f4de5319a9a59614eb66c4c51c8821543609526278fde1a
-  data.tar.gz: 908b61f2a4aa9e5295c6ca322ffc6b97eca682c519d85c5bbc433a50843e329474ec04e924f034345677758fced4d23fa28c7c7f8eeb8dbbe4e4b5c071d463ec
+  metadata.gz: af50a4ec445fe61a69a53e2a5408924fccdd5a229caf5b7d8ee1e6216760ac29d72be36eff6f7e4e7f78150020fa2dbd0807a27af6e414e81d056e613c168012
+  data.tar.gz: 4540eb9f231f5a366c230e570beeffaa5d0082b90b84dc85a67ad5c33dd94114a6b21b5c017545d815c37e12fb93d1c8a6b2cdf818109abf0ad8c86e00f3b77f

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.3.0] - 2024-06-29
+
+- Added constants for the main Claude models
+- Added default user_message payload
+- Added parse_response method
+
+## [0.2.1] - 2024-03-24
+
+- Fixed dependencies
+
+## [0.2.0] - 2024-03-24
+
+- Changed to use httparty
+
 ## [0.1.1] - 2024-03-10
 
 - Initial release

data/Gemfile.lock

@@ -1,30 +1,22 @@
 PATH
   remote: .
   specs:
-    claude-ruby (0.2.0)
-      rest-client
+    claude-ruby (0.2.1)
+      httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     docile (1.4.0)
-    domain_name (0.6.20240107)
-    http-accept (1.7.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
-    mime-types (3.5.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2024.0305)
     mini_mime (1.1.5)
     minitest (5.22.2)
     multi_xml (0.6.0)
-    netrc (0.11.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -33,11 +25,6 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
     rexml (3.2.6)
     rubocop (1.62.0)
       json (~> 2.3)

data/README.md

@@ -59,33 +59,52 @@ It requires an array of messages where each message is a hash with two propertie
 
 Simple example with a single user message:
 
+```ruby
+messages = claude_client.user_message("Who was the first team to win the rugby world cup?")
+response = claude_client.messages(messages)
+```
+
+The response contains a bunch of metadata and the model's message response.
+To extract the message text you can use:
+
+```ruby
+claude_client.parse_response(response)
+```
+
+Or parse the response yourself:
+
+```ruby
+response['content'][0]['text']
+```
+
+```claude_client.user_message``` is just for simple user messages. For more complex messages you can specify the payload in detail:
+
 ```ruby
 messages = [
   {
     role: "user",
-    content: "Who was the first team to win the rugby world cup?"
+    content: "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+  },
+  {
+    role: "assistant",
+    content: "The best answer is ("
   }
 ]
 
 response = claude_client.messages(messages)
 ```
 
-The response contains a bunch of metadata and the model's message response.
-To extract the message text you can you code like this:
-
-```ruby
-response['content'][0]['text']
-```
 
 You can continue the conversation by calling the `messages` method again with an expanded messages array:
 
 ```ruby
 
-messages << {role: "assistant", content: "New Zealand won the first Rugby World Cup in 1987"}
-messages << {role: "user", content: "Who came third and fourth in that competition?"}
+messages = [{ role: "user", content: "Who was the first team to win the rugby world cup?" }]
+messages << { role: "assistant", content: "New Zealand won the first Rugby World Cup in 1987" }
+messages << { role: "user", content: "Who came third and fourth in that competition?" }
 
 response = claude_client.messages(messages)
-puts response['content'][0]['text'] # This will give you the updated message
+puts claude_client.parse_response(response) # This will give you the updated message
 ```
 
 Example with a more sophisticated message structure:
@@ -108,7 +127,46 @@ messages = [
   },
 ]
 
-response = claude_client.messages(messages, {system: system})
+response = claude_client.messages(messages, { system: system })
+```
+
+## Vision
+
+It's possible to pass an image to the Anthropic API and have Claude describe the image for you.
+Here's an example how to do that using claude-ruby gem:
+
+```ruby
+require 'httparty'
+require 'base64'
+
+def fetch_and_encode_image(url)
+  response = HTTParty.get(url)
+  Base64.strict_encode64(response.body)
+end
+
+image_url = "https://images.unsplash.com/photo-1719630668118-fb27d922b165?ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D&fm=jpg&fit=crop&w=1080&q=80&fit=max"
+messages = [
+    {
+        "role": "user",
+        "content": [
+            {
+                "type": "image",
+                "source": {
+                    "type": "base64",
+                    "media_type": "image/jpeg",
+                    "data": fetch_and_encode_image(image_url),
+                },
+            },
+            {
+                "type": "text",
+                "text": "Describe this image."
+            }
+        ],
+    }
+]
+
+response = claude_client.messages(messages)
+image_description = claude_client.parse_response(response)
 ```
 
 For further details of the API visit https://docs.anthropic.com/claude/reference/messages_post

data/lib/claude/client.rb

@@ -3,6 +3,23 @@ require 'json'
 
 module Claude
   class Client
+    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'
+
+    MODEL_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
+
+    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
+
+    MODEL_CLAUDE_DEFAULT = MODEL_CLAUDE_SONNET_LATEST
 
     def initialize(api_key)
       @api_key = api_key
@@ -10,15 +27,16 @@ module Claude
     end
 
     def messages(messages, params = {})
-      model = params[:model] || 'claude-3-opus-20240229'
-      max_tokens = params[:max_tokens] || 1024
+      model = params[:model] || MODEL_CLAUDE_DEFAULT
+      max_tokens = params[:max_tokens] || 4096
+      system = params[:system] || "You are a helpful assistant."
 
       url = "#{@endpoint}/messages"
 
       data = {
         model: model,
         messages: messages,
-        system: params[:system],
+        system: system,
         max_tokens: max_tokens,
         metadata: params[:metadata],
         stop_sequences: params[:stop_sequences],
@@ -39,6 +57,19 @@ module Claude
       }
     end
 
+    def user_message(user_message)
+      [
+        {
+          "role": "user",
+          "content": user_message,
+        }
+      ]
+    end
+
+    def parse_response(response)
+      response['content'][0]['text']
+    end
+
     private
 
     def post_api(url, data)

data/lib/claude/ruby/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: claude-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Web Ventures Ltd
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-24 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,7 @@ 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