claude-ruby 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1abcb271e41e71527b088aec3c34b4112a2c2683889a213b6be9f36e8dcae609
-  data.tar.gz: ad48b663ac70e5308a5f9e9b3b98a0ae53ed660c2fce1de7a085b083e613669a
+  metadata.gz: f0914fd554c4c01686d477c44cf2de423f0faad30d673e39a767d0296da1cac4
+  data.tar.gz: fe9e0aa7f262c1af5fe3b0036136739a87f718c040f107c7ad792cb1492fe752
 SHA512:
-  metadata.gz: 80913b8e75720d8685686e6ca6ee7077e09e4e0c46cf6fe8123da979deeaff21f54e383160a95e2084da50514ef170be21a60d019ba5a0de5b06bb1b827b6e81
-  data.tar.gz: 410e6ba1ed7dd2e5ab6f6abeba3e06c9769b9d57ab769139690dcb8d79ad669b394774488b09620216b41616382516022a670b3f6a88bf1793a2315ac47562b1
+  metadata.gz: 5dba3fa917472c533a8d515624346ec40ccd95ebd79e803ad9d0fd536a4aaab3b4bb0c9281d97a9baf0c12c87c7c2849b23dec5a51128e28a2099f47274fbf05
+  data.tar.gz: a0e033b78ced858eae7d8fb196f40ecb04ef540dadcd76e77ba8e2cff177b12642579cbcb0114d27da1336dd26846fa10ebb3cfa2ae0641870e0db33b2c278e0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.3.1] - 2024-06-29
+- Updated documentation
+ 
+## [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

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

@@ -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: "In which year was the first ever rugby world cup? (A) 1983 (B) 1987 (C) 1991"
+  },
+  {
+    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,100 @@ messages = [
   },
 ]
 
-response = claude_client.messages(messages, {system: system})
+response = claude_client.messages(messages, { system: system })
+```
+
+## Models
+
+If you don't specify a model, then the gem will use the latest version of Clause 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::Client::MODEL_CLAUDE_OPUS_LATEST
+Claude::Client::MODEL_CLAUDE_SONNET_LATEST
+Claude::Client::MODEL_CLAUDE_HAIKU_LATEST
+
+Claude::Client::MODEL_CLAUDE_FASTEST
+Claude::Client::MODEL_CLAUDE_CHEAPEST
+Claude::Client::MODEL_CLAUDE_BALANCED
+Claude::Client::MODEL_CLAUDE_SMARTEST
+````
+
+Example usage:
+
+```ruby
+response = claude_client.messages(messages, { model: Claude::Client::MODEL_CLAUDE_CHEAPEST })
+````
+
+## 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
+````
+
+Example:
+
+```ruby
+response = claude_client.messages(messages, 
+                                  { model: Claude::Client::MODEL_CLAUDE_SMARTEST,
+                                    max_tokens: 500,
+                                    temperature: 0.1 })
+````
+
+## 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.1"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: claude-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 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: httparty