claude-ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acba80183a9f1ade551f7c6b948f24b02e0f3d1eedf784a50715c48e4bfbec78
-  data.tar.gz: 35f49c5e0f3e51da700808a48ecd017dbe5251ab0eaaddccab7439a82a5947fb
+  metadata.gz: f0914fd554c4c01686d477c44cf2de423f0faad30d673e39a767d0296da1cac4
+  data.tar.gz: fe9e0aa7f262c1af5fe3b0036136739a87f718c040f107c7ad792cb1492fe752
 SHA512:
-  metadata.gz: af50a4ec445fe61a69a53e2a5408924fccdd5a229caf5b7d8ee1e6216760ac29d72be36eff6f7e4e7f78150020fa2dbd0807a27af6e414e81d056e613c168012
-  data.tar.gz: 4540eb9f231f5a366c230e570beeffaa5d0082b90b84dc85a67ad5c33dd94114a6b21b5c017545d815c37e12fb93d1c8a6b2cdf818109abf0ad8c86e00f3b77f
+  metadata.gz: 5dba3fa917472c533a8d515624346ec40ccd95ebd79e803ad9d0fd536a4aaab3b4bb0c9281d97a9baf0c12c87c7c2849b23dec5a51128e28a2099f47274fbf05
+  data.tar.gz: a0e033b78ced858eae7d8fb196f40ecb04ef540dadcd76e77ba8e2cff177b12642579cbcb0114d27da1336dd26846fa10ebb3cfa2ae0641870e0db33b2c278e0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [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,60 @@ 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 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.

data/lib/claude/ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: claude-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Web Ventures Ltd
@@ -38,7 +38,6 @@ 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