anthropic-rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8ddefe11f23c3a4da77b1307a68000db35da9ba1607407eff8cccdf21cc1d3a
-  data.tar.gz: 936ecaf281b8f9662c689ea64c98f317f9de29a8f87f4888cf227f412efed688
+  metadata.gz: a00be2a4defb2218b159f10759e861f3f4d314909fb9205bb11cb79dd4460eec
+  data.tar.gz: 6cb65d16c68d5fc58094210ebd271908c58e1927366887d64ef59100aced49cf
 SHA512:
-  metadata.gz: 8ba132ede7fdf85de9c9641e32601b4c544101e421a950f9fd5f25edf43397b25a3f7c7f4a27996bcd71832acf6211fb24baf1d3f58d7a927d26e1c098f67bdd
-  data.tar.gz: 74646ab569768708d8505c9843352a418cfcc0a88e8528834647d8ee30fe6b2f3840d1ab75d3bd0fbd21d6afe25e2e82c2cb922b089979260cd5c13a5eeeda49
+  metadata.gz: f6c0aadeacd66bddd7ab58393cb86a3b50d1e99eb8df9d0e6fe076376c71ef0f2430f864666420af180f5da828d770ced1128dbeb59f77cf8d2f28df28b699c8
+  data.tar.gz: 4df1ea4f97c164bee7cbe1a2a7f92c57a1a507220a2ec62c4d9442978674b1d5b5197092ecba83f77a1ef302919b35357adcda22a4c41e9e90098ccd459e7497

data/.reek.yml

@@ -0,0 +1,7 @@
+detectors:
+  ControlParameter:
+    exclude:
+      - Anthropic#self.api_key=
+  TooManyStatements:
+    exclude:
+      - 'Anthropic::Client#self.post'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
+# Changelog
+
 ## [Unreleased]
 
 ## [0.1.0] - 2023-11-30
 
+### Added
+
 - Initial release
+
+[Unreleased]: https://github.com/d3d1rty/event_logger_rails/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/d3d1rty/event_logger_rails/releases/tag/0.1.0

data/README.md

@@ -2,9 +2,75 @@
 
 Ruby bindings for the Anthropic API. This library is unofficial and is not affiliated with Anthropic PBC.
 
+The goal of this project is feature parity with Anthropic's Python SDK until an official Ruby SDK is available.
+
 ## Usage
 
-TODO: Write some code to use
+anthropic-rb will default to the value of the `ANTHROPIC_API_KEY` environment variable. However, you may initialize the library with your API key:
+
+```ruby
+require 'anthropic-rb'
+
+Anthropic.setup do |config|
+  config.api_key = 'YOUR_API_KEY'
+end
+```
+
+You can also specify an API version to use by setting the `ANTHROPIC_API_VERSION` environment variable or during initialization:
+
+```ruby
+require 'anthropic-rb'
+
+Anthropic.setup do |config|
+  config.api_version = '2023-06-01'
+end
+```
+
+The default API version is `2023-06-01`.
+
+To make a request to the Completions API:
+
+```ruby
+Anthropic.completions.create(
+  model: 'claude-2',
+  max_tokens_to_sample: 200,
+  prompt: 'Human: Yo what up?\n\nAssistant:'
+)
+
+# Output =>
+# {
+#   completion: "Hello! Not much going on with me, just chatting. How about you?",
+#   stop_reason: "stop_sequence",
+#   model: "claude-2.1",
+#   stop: "\n\nHuman:",
+#   log_id: "2496914137c520ec2b4ae8315864bcf3a4c6ce9f2e3c96e13be4c004587313ca"
+# }
+```
+
+Alternatively, you can stream the response:
+
+```ruby
+Anthropic.completions.create(model: 'claude-2', max_tokens_to_sample: 200, prompt: 'Human: Yo what up?\n\nAssistant:') do |event|
+  puts event
+end
+
+# Output =>
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" Hello", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"!", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" Not", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" much", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>",", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" just", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" chatting", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" with", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" people", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>".", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" How", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" about", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>" you", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"?", :stop_reason=>nil, :model=>"claude-2.1", :stop=>nil, :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+# {:type=>"completion", :id=>"compl_01G6cEfdZtLEEJVRzwUShiDY", :completion=>"", :stop_reason=>"stop_sequence", :model=>"claude-2.1", :stop=>"\n\nHuman:", :log_id=>"compl_01G6cEfdZtLEEJVRzwUShiDY"}
+```
 
 ## Installation
 

data/lib/anthropic/client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'httpx'
+
+module Anthropic
+  ##
+  # Error when the request is malformed.
+  class BadRequestError < StandardError; end
+  ##
+  # Error when the API key is invalid.
+  class AuthenticationError < StandardError; end
+  ##
+  # Error when the account does not have permission for the operation.
+  class PermissionDeniedError < StandardError; end
+  ##
+  # Error when the resource is not found.
+  class NotFoundError < StandardError; end
+  ##
+  # Error when the resource already exists.
+  class ConflictError < StandardError; end
+  ##
+  # Error when the resource cannot be processed.
+  class UnprocessableEntityError < StandardError; end
+  ##
+  # Error when the request exceeds the rate limit.
+  class RateLimitError < StandardError; end
+  ##
+  # Error when the server experienced an internal error.
+  class InternalServerError < StandardError; end
+
+  ##
+  # Provides a client for sending HTTP requests.
+  class Client
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+    def self.post(url, data)
+      response = HTTPX.with(
+        headers: {
+          'Content-Type' => 'application/json',
+          'x-api-key' => Anthropic.api_key,
+          'anthropic-version' => Anthropic.api_version
+        }
+      ).post(url, json: data)
+
+      response_body = JSON.parse(response.body, symbolize_names: true)
+
+      case response.status
+      when 200
+        response_body
+      when 400
+        raise Anthropic::BadRequestError, response_body
+      when 401
+        raise Anthropic::AuthenticationError, response_body
+      when 403
+        raise Anthropic::PermissionDeniedError, response_body
+      when 404
+        raise Anthropic::NotFoundError, response_body
+      when 409
+        raise Anthropic::ConflictError, response_body
+      when 422
+        raise Anthropic::UnprocessableEntityError, response_body
+      when 429
+        raise Anthropic::RateLimitError, response_body
+      when 500
+        raise Anthropic::InternalServerError, response_body
+      end
+    end
+
+    def self.post_as_stream(url, data)
+      response = HTTPX.plugin(:stream).with(
+        headers: {
+          'Content-Type' => 'application/json',
+          'x-api-key' => Anthropic.api_key,
+          'anthropic-version' => Anthropic.api_version
+        }
+      ).post(url, json: data, stream: true)
+
+      response.each_line do |line|
+        event, data = line.split(/(\w+\b:\s)/)[1..2]
+        next unless event && data
+
+        if event.start_with?('data')
+          formatted_data = JSON.parse(data, symbolize_names: true)
+          yield formatted_data unless %w[ping error].include?(formatted_data[:type])
+        end
+      end
+    rescue HTTPX::HTTPError => error
+      case error.response.status
+      when 400
+        raise Anthropic::BadRequestError
+      when 401
+        raise Anthropic::AuthenticationError
+      when 403
+        raise Anthropic::PermissionDeniedError
+      when 404
+        raise Anthropic::NotFoundError
+      when 409
+        raise Anthropic::ConflictError
+      when 422
+        raise Anthropic::UnprocessableEntityError
+      when 429
+        raise Anthropic::RateLimitError
+      when 500
+        raise Anthropic::InternalServerError
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+  end
+end

data/lib/anthropic/completions.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Anthropic
+  ##
+  # Provides bindings for the Anthropic completions API
+  class Completions
+    # Error for when the API version is not supported.
+    class UnsupportedApiVersionError < StandardError; end
+
+    V1_SCHEMA = {
+      type: 'object',
+      required: %w[model prompt max_tokens_to_sample],
+      properties: {
+        model: { type: 'string' },
+        prompt: { type: 'string' },
+        max_tokens_to_sample: { type: 'integer' },
+        stop_sequences: { type: 'array', items: { type: 'string' } },
+        temperature: { type: 'number' },
+        top_k: { type: 'integer' },
+        top_p: { type: 'number' },
+        metadata: { type: 'object' },
+        stream: { type: 'boolean' }
+      },
+      additionalProperties: false
+    }.freeze
+
+    def initialize
+      @endpoint = 'https://api.anthropic.com/v1/complete'
+    end
+
+    def create(**params, &)
+      JSON::Validator.validate!(schema_for_api_version, params)
+      return Anthropic::Client.post(endpoint, params) unless params[:stream]
+
+      Anthropic::Client.post_as_stream(endpoint, params, &)
+    rescue JSON::Schema::ValidationError => error
+      raise ArgumentError, error.message
+    end
+
+    private
+
+    attr_reader :endpoint
+
+    def schema_for_api_version
+      api_version = Anthropic.api_version
+      case api_version
+      when '2023-06-01'
+        V1_SCHEMA
+      else
+        raise UnsupportedApiVersionError, "Unsupported API version: #{api_version}"
+      end
+    end
+  end
+end

data/lib/anthropic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anthropic
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/anthropic.rb

@@ -1,9 +1,46 @@
 # frozen_string_literal: true
 
+require 'httpx'
+require 'json'
+require 'json-schema'
+
+require_relative 'anthropic/client'
+require_relative 'anthropic/completions'
 require_relative 'anthropic/version'
 
+##
+# Namespace for anthropic-rb gem
 module Anthropic
   ##
   # Default error class
   class Error < StandardError; end
+
+  def self.setup
+    yield self
+  end
+
+  def self.reset
+    @api_key = nil
+    @api_version = nil
+  end
+
+  def self.api_key
+    @api_key || ENV.fetch('ANTHROPIC_API_KEY', nil)
+  end
+
+  def self.api_key=(api_key = nil)
+    @api_key = api_key
+  end
+
+  def self.api_version
+    @api_version || ENV.fetch('ANTHROPIC_API_VERSION', '2023-06-01')
+  end
+
+  def self.api_version=(api_version = nil)
+    @api_version = api_version
+  end
+
+  def self.completions
+    Completions.new
+  end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: anthropic-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dick Davis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
-dependencies: []
+date: 2023-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
 description:
 email:
 - dick@hey.com
@@ -18,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".overcommit.yml"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
@@ -26,6 +55,8 @@ files:
 - README.md
 - Rakefile
 - lib/anthropic.rb
+- lib/anthropic/client.rb
+- lib/anthropic/completions.rb
 - lib/anthropic/version.rb
 - sig/anthropic/rb.rbs
 homepage: https://github.com/dickdavis/anthropic-rb