anthropic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bf4e9a547533edb57fcaee7dd07c8c1a5c7d3f5291b539541b9b9b8c3b5e614
-  data.tar.gz: e62081a581aa15d9b8dbd335fb6b989671eb733629b64992c847584e83100c4e
+  metadata.gz: 5591b52e376e9a5915a3011d9919d188aaa441fa65f6a8d665b160c5529b0564
+  data.tar.gz: e251bf3dd61569807e722f6fe116498fd6801e07fc2333c2f2f40c03e61b5b9f
 SHA512:
-  metadata.gz: dc148818d355a80050ae35c9b7a60d48dfa713826b9607d9add0ceb70b88da4b19f7b650dae1b5714ea41003fcec94cd4bc2fd226f999c3e4c3562d681a8100a
-  data.tar.gz: 683dedfd00584546691bde56a569f2a043a0ba8b9806450e5baabcdbc0c0ff28960778c9cda600bea5b13a8024b01337e1f271f363508dd657424ad6da3b3fbd
+  metadata.gz: 6beac221f3595b6599e37175190a59fc20681aa679d7746f060447850aab0b4ca7362ef5ce99a458a9ce1a5f6acfc5a6491ca5bdb7147efadf14cca068576d08
+  data.tar.gz: 39189b30389c23c56956b32135587513f3ae7f2927e323262333c82392b5c24239c3a94486a68b2bd569856fe34334a19eb8a3ad7a0f0d99ef9bd5ec16283580

data/CHANGELOG.md

@@ -5,14 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.0.0] - 2023-07-12
+## [0.2.0] - 2024-04-25
 
 ### Added
 
-- Initialise repository.
+- Add new Messages endpoint - thanks [@deepakmahakale](https://github.com/deepakmahakale) for the PR, [@obie](https://github.com/obie) for the first pass, and many others for requesting and contributions!
 
 ## [0.1.0] - 2023-07-18
 
 ### Changed
 
 - Got the gem working with the API. MVP
+
+## [0.0.0] - 2023-07-12
+
+### Added
+
+- Initialise repository.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    anthropic (0.1.0)
+    anthropic (0.2.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
 

data/README.md

@@ -1,18 +1,16 @@
-# Anthropic (WIP)
+# Anthropic
 
 [![Gem Version](https://badge.fury.io/rb/anthropic.svg)](https://badge.fury.io/rb/anthropic)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/anthropic/blob/main/LICENSE.txt)
 [![CircleCI Build Status](https://circleci.com/gh/alexrudall/anthropic.svg?style=shield)](https://circleci.com/gh/alexrudall/anthropic)
 
-Use the [Anthropic API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api) with Ruby! 🌌❤️
+Use the [Anthropic API](https://docs.anthropic.com/claude/reference/getting-started-with-the-api) with Ruby! 🤖🌌
 
 You can apply for access to the API [here](https://docs.anthropic.com/claude/docs/getting-access-to-claude).
 
-[Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD)
+🚢 Need someone to ship critical Rails features for you, fast? I'm taking on a few new clients at an experimental crazy low price, check it out: [railsai.com](https://railsai.com?utm_source=anthropic&utm_medium=readme&utm_id=26072023)
 
-[Rails AI Guides](https://railsai.com)
-
-Follow me on [Twitter](https://twitter.com/alexrudall) for more Ruby / AI content!
+[🎮 Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD) | [🐦 Twitter](https://twitter.com/alexrudall) | [🤖 OpenAI Gem](https://github.com/alexrudall/ruby-openai) | [🚂 Midjourney Gem](https://github.com/alexrudall/midjourney)
 
 ### Bundler
 
@@ -52,11 +50,15 @@ client = Anthropic::Client.new(access_token: "access_token_goes_here")
 
 ### With Config
 
-For a more robust setup, you can configure the gem with your API keys, for example in an `anthropic.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+For a more robust setup, you can configure the gem with your API keys, for example in an `anthropic.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments or rails credentials if you are using this in a rails project.
 
 ```ruby
 Anthropic.configure do |config|
-    config.access_token = ENV.fetch("ANTHROPIC_API_KEY")
+  # With dotenv
+  config.access_token = ENV.fetch("ANTHROPIC_API_KEY")
+  # OR
+  # With Rails credentials
+  config.access_token = Rails.application.credentials.dig(:anthropic, :api_key)
 end
 ```
 
@@ -74,9 +76,9 @@ The default timeout for any request using this library is 120 seconds. You can c
 
 ```ruby
 client = Anthropic::Client.new(
-    access_token: "access_token_goes_here",
-    anthropic_version: "2023-01-01", # Optional
-    request_timeout: 240 # Optional
+  access_token: "access_token_goes_here",
+  anthropic_version: "2023-01-01", # Optional
+  request_timeout: 240 # Optional
 )
 ```
 
@@ -84,40 +86,54 @@ You can also set these keys when configuring the gem:
 
 ```ruby
 Anthropic.configure do |config|
-    config.access_token = ENV.fetch("ANTHROPIC_API_KEY")
-    config.anthropic_version = "2023-01-01" # Optional
-    config.request_timeout = 240 # Optional
+  config.access_token = ENV.fetch("ANTHROPIC_API_KEY")
+  config.anthropic_version = "2023-01-01" # Optional
+  config.request_timeout = 240 # Optional
 end
 ```
 
-### Completions
-
-Hit the Anthropic API for a completion:
-
-```ruby
-response = client.complete(
-    parameters: {
-        model: "claude-2",
-        prompt: "How high is the sky?",
-        max_tokens_to_sample: 5
-    })
-puts response["completion"]
-# => " The sky has no definitive"
-```
+### Models
 
-Note that all requests are prepended by this library with
+Available Models:
 
-`\n\nHuman: `
+| Name            | API Name                 |
+| --------------- | ------------------------ |
+| Claude 3 Opus   | claude-3-opus-20240229   |
+| Claude 3 Sonnet | claude-3-sonnet-20240229 |
+| Claude 3 Haiku  | claude-3-haiku-20240307  |
 
-and appended with
+You can find the latest model names in the [Anthropic API documentation](https://docs.anthropic.com/claude/docs/models-overview#model-recommendations).
 
-`\n\nAssistant:`
+### Messages
 
-so whatever prompt you pass will be sent to the API as
+```
+POST https://api.anthropic.com/v1/messages
+```
 
-`\n\nHuman: How high is the sky?\n\nAssistant:`
+Send a sequence of messages (user or assistant) to the API and receive a message in response.
 
-This is a requirement of [the API](https://docs.anthropic.com/claude/reference/complete_post).
+```ruby
+response = client.messages(
+  parameters: {
+    model: "claude-3-haiku-20240307", # claude-3-opus-20240229, claude-3-sonnet-20240229
+    system: "Respond only in Spanish.",
+    messages: [
+      {"role": "user", "content": "Hello, Claude!"}
+    ],
+    max_tokens: 1000
+  }
+)
+# => {
+# =>   "id" => "msg_0123MiRVCgSG2PaQZwCGbgmV",
+# =>   "type" => "message",
+# =>   "role" => "assistant",
+# =>   "content" => [{"type"=>"text", "text"=>"¡Hola! Es un gusto saludarte. ¿En qué puedo ayudarte hoy?"}],
+# =>   "model" => "claude-3-haiku-20240307",
+# =>   "stop_reason" => "end_turn",
+# =>   "stop_sequence" => nil,
+# =>   "usage" => {"input_tokens"=>17, "output_tokens"=>32}
+# => }
+```
 
 ## Development
 
@@ -125,6 +141,11 @@ After checking out the repo, run `bin/setup` to install dependencies. You can ru
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+To run all tests, execute the command `bundle exec rake`, which will also run the linter (Rubocop). This repository uses [VCR](https://github.com/vcr/vcr) to log API requests.
+
+> [!WARNING]
+> If you have an `ANTHROPIC_API_KEY` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+
 ### Warning
 
 If you have an `ANTHROPIC_API_KEY` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.

data/Rakefile

@@ -1,6 +1,19 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :default do
+  Rake::Task["test"].invoke
+  Rake::Task["lint"].invoke
+end
+
+task :test do
+  Rake::Task["spec"].invoke
+end
+
+task :lint do
+  RuboCop::RakeTask.new(:rubocop)
+  Rake::Task["rubocop"].invoke
+end

data/anthropic.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alex"]
   spec.email         = ["alexrudall@users.noreply.github.com"]
 
-  spec.summary       = "Anthropic API + Ruby! 🌌❤️"
+  spec.summary       = "Anthropic API + Ruby! 🤖🌌"
   spec.homepage      = "https://github.com/alexrudall/anthropic"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")

data/lib/anthropic/client.rb

@@ -16,6 +16,10 @@ module Anthropic
       Anthropic::Client.json_post(path: "/complete", parameters: parameters)
     end
 
+    def messages(parameters: {})
+      Anthropic::Client.json_post(path: "/messages", parameters: parameters)
+    end
+
     private
 
     def wrap_prompt(prompt:, prefix: "\n\nHuman: ", suffix: "\n\nAssistant:")

data/lib/anthropic/version.rb

@@ -1,3 +1,3 @@
 module Anthropic
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anthropic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -93,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
-summary: "Anthropic API + Ruby! \U0001F30C❤️"
+summary: "Anthropic API + Ruby! \U0001F916\U0001F30C"
 test_files: []