omniai-anthropic 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7900bc46e3d783c4d1cb28d9c248a925637ab77fbce37f4e1291862e1f0a0915
-  data.tar.gz: 7fb90b9e78c51c5c6532d6f306e6e2c758661512c64bf693b13aa402177cdfe8
+  metadata.gz: f431b98530e904ca88f4860c87fcaf4d44d3960a58158ae91a20e0ff06a67e83
+  data.tar.gz: c8a45bf94836565c387394558641253a7665d33e95537c13d642c4f21a6f9fa9
 SHA512:
-  metadata.gz: 31cfca2a6d0608541055324595427711f485ce8d95497f37b90429e7be09a35050530289329f8afa98e23a446d7dbb19368c3403f222c3d5813a8447d3027be5
-  data.tar.gz: abc2fbf0475642cc8bb420bdded5277d1335b542bf2526817bb65acebc169b07d4bde26050704667a473c4c6b5eb4177b67d7cf6646fb2b986c4d4b5a183e7ba
+  metadata.gz: c37e3b9502f43209bc5d6fe9902d51460d09f55c56f9fdcb6567ac6e7a461d7857d1cda6982afc6058d992b158c179b2aa48d285bba710c066b27cc5a00f4ef2
+  data.tar.gz: 6e7f50fea78c63919c101c5e6e591227b286a09806e854fff101d066a9a7ed084977f615b27dcdfe3018119ca20c0513f8ceae5668daf250d33ba115b31cc9ff

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+gem 'rspec'
+gem 'rspec_junit_formatter'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'webmock'

data/README.md

@@ -1,31 +1,111 @@
-# Omniai::Anthropic
+# OmniAI::Anthropic
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniai/anthropic`. To experiment with that code, run `bin/console` for an interactive prompt.
+An Anthropic implementation of the [OmniAI](https://github.com/ksylvest/omniai) APIs.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+```sh
+gem install omniai-anthropic
+```
 
-Install the gem and add to the application's Gemfile by executing:
+## Usage
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+### Client
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+A client is setup as follows if `ENV['ANTHROPIC_API_KEY']` exists:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+client = OmniAI::Anthropic::Client.new
+```
 
-## Usage
+A client may also be passed the following options:
+
+- `api_key` (required - default is `ENV['ANTHROPIC_API_KEY']`)
+- `host` (optional)
+
+### Configuration
+
+Global configuration is supported for the following options:
+
+```ruby
+OmniAI::Anthropic.configure do |config|
+  config.api_key = '...' # default: ENV['ANTHROPIC_API_KEY']
+  config.host = '...' # default: 'https://api.anthropic.com'
+end
+```
+
+### Chat
+
+A chat completion is generated by passing in prompts using any a variety of formats:
+
+```ruby
+completion = client.chat('Tell me a joke!')
+completion.choice.message.content # 'Why did the chicken cross the road? To get to the other side.'
+```
+
+```ruby
+completion = client.chat({
+  role: OmniAI::Chat::Role::USER,
+  content: 'Is it wise to jump off a bridge?'
+})
+completion.choice.message.content # 'No.'
+```
+
+```ruby
+completion = client.chat([
+  {
+    role: OmniAI::Chat::Role::SYSTEM,
+    content: 'You are a helpful assistant.'
+  },
+  'What is the capital of Canada?',
+])
+completion.choice.message.content # 'The capital of Canada is Ottawa.'
+```
+
+#### Model
+
+`model` takes an optional string (default is `claude-3-haiku-20240307`):
+
+```ruby
+completion = client.chat('Provide code for fibonacci', model: OmniAI::Anthropic::Chat::Model::OPUS)
+completion.choice.message.content # 'def fibonacci(n)...end'
+```
+
+[Anthropic API Reference `model`](https://docs.anthropic.com/en/api/messages)
+
+#### Temperature
+
+`temperature` takes an optional float between `0.0` and `1.0` (defaults is `0.7`):
+
+```ruby
+completion = client.chat('Pick a number between 1 and 5', temperature: 1.0)
+completion.choice.message.content # '3'
+```
+
+[Anthropic API Reference `temperature`](https://docs.anthropic.com/en/api/messages)
+
+#### Stream
+
+`stream` takes an optional a proc to stream responses in real-time chunks instead of waiting for a complete response:
 
-TODO: Write usage instructions here
+```ruby
+stream = proc do |chunk|
+  print(chunk.choice.delta.content) # 'Better', 'three', 'hours', ...
+end
+client.chat('Be poetic.', stream:)
+```
 
-## Development
+[Anthropic API Reference `stream`](https://docs.anthropic.com/en/api/messages)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Format
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`format` takes an optional symbol (`:json`) and modifies requests to send additional system text requesting JSON:
 
-## Contributing
+```ruby
+completion = client.chat([
+  { role: OmniAI::Chat::Role::USER, content: 'What is the name of the drummer for the Beatles?' }
+], format: :json)
+JSON.parse(completion.choice.message.content) # { "name": "Ringo" }
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniai-anthropic.
+[Anthropic API Reference `control-output-format`](https://docs.anthropic.com/en/docs/control-output-format)

data/lib/omniai/anthropic/chat/completion.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Anthropic
+    class Chat
+      # A completion returned by the API.
+      class Completion < OmniAI::Chat::Completion
+        # @return [Array<OmniAI::Chat::Choice>]
+        def choices
+          @choices ||= begin
+            role = @data['role']
+
+            @data['content'].map do |data, index|
+              OmniAI::Chat::Choice.new(data: {
+                'index' => index,
+                'message' => { 'role' => role, 'content' => data['text'] },
+              })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/anthropic/chat/stream.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Anthropic
+    class Chat
+      # A stream given when streaming.
+      class Stream < OmniAI::Chat::Stream
+        module Type
+          PING = 'ping'
+          MESSAGE_START = 'message_start'
+          MESSAGE_STOP = 'message_stop'
+          MESSAGE_DELTA = 'message_delta'
+          CONTENT_BLOCK_START = 'content_block_start'
+          CONTENT_BLOCK_STOP = 'content_block_stop'
+          CONTENT_BLOCK_DELTA = 'content_block_delta'
+        end
+
+        # Process the stream into chunks by event.
+        class Builder
+          attr_reader :id, :model, :role, :content, :index
+
+          # @return [OmniAI::Chat::Chunk]
+          def chunk
+            OmniAI::Chat::Chunk.new(data: {
+              'id' => @id,
+              'model' => @model,
+              'choices' => [{
+                'index' => @index,
+                'delta' => { 'role' => @role, 'content' => @content },
+              }],
+            })
+          end
+
+          # Handler for Type::MESSAGE_START
+          #
+          # @param data [Hash]
+          def message_start(data)
+            @id = data['id']
+            @model = data['model']
+            @role = data['role']
+          end
+
+          # Handler for Type::MESSAGE_STOP
+          #
+          # @param data [Hash]
+          def message_stop(_)
+            @id = nil
+            @model = nil
+            @role = nil
+          end
+
+          # Handler for Type::CONTENT_BLOCK_START
+          #
+          # @param data [Hash]
+          def content_block_start(data)
+            @index = data['index']
+          end
+
+          # Handler for Type::CONTENT_BLOCK_STOP
+          #
+          # @param data [Hash]
+          def content_block_stop(_)
+            @index = nil
+          end
+
+          # Handler for Type::CONTENT_BLOCK_DELTA
+          #
+          # @param data [Hash]
+          def content_block_delta(data)
+            return unless data['delta']['type'].eql?('text_delta')
+
+            @content = data['delta']['text']
+          end
+        end
+
+        # @yield [OmniAI::Chat::Chunk]
+        def stream!(&block)
+          builder = Builder.new
+
+          @response.body.each do |chunk|
+            @parser.feed(chunk) do |type, data|
+              process(type:, data: JSON.parse(data), builder:, &block)
+            end
+          end
+        end
+
+        private
+
+        # @param type [String]
+        # @param data [Hash]
+        # @param builder [Builder]
+        def process(type:, data:, builder:, &)
+          case type
+          when Type::MESSAGE_START then builder.message_start(data)
+          when Type::CONTENT_BLOCK_START then builder.content_block_start(data)
+          when Type::CONTENT_BLOCK_STOP then builder.content_block_stop(data)
+          when Type::MESSAGE_STOP then builder.message_stop(data)
+          when Type::CONTENT_BLOCK_DELTA
+            builder.content_block_delta(data)
+            yield(builder.chunk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/anthropic/chat.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Anthropic
+    # A Anthropic chat implementation.
+    #
+    # Usage:
+    #
+    #   chat = OmniAI::Anthropic::Chat.new(client: client)
+    #   chat.completion('Tell me a joke.')
+    #   chat.completion(['Tell me a joke.'])
+    #   chat.completion({ role: 'user', content: 'Tell me a joke.' })
+    #   chat.completion([{ role: 'system', content: 'Tell me a joke.' }])
+    class Chat < OmniAI::Chat
+      module Model
+        HAIKU = 'claude-3-haiku-20240307'
+        SONNET = 'claude-3-sonnet-20240229'
+        OPUS = 'claude-3-opus-20240229'
+      end
+
+      protected
+
+      # @param response [HTTP::Response]
+      # @return [OmniAI::Anthropic::Chat::Stream]
+      def stream!(response:)
+        raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
+
+        Stream.new(response:).stream! { |chunk| @stream.call(chunk) }
+      end
+
+      # @param response [HTTP::Response]
+      # @param response [OmniAI::Anthropic::Chat::Completion]
+      def complete!(response:)
+        Completion.new(data: response.parse)
+      end
+
+      # @return [Hash]
+      def payload
+        OmniAI::Anthropic.config.chat_options.merge({
+          model: @model,
+          messages: messages.filter { |message| !message[:role].eql?(OmniAI::Chat::Role::SYSTEM) },
+          system:,
+          stream: @stream.nil? ? nil : !@stream.nil?,
+          temperature: @temperature,
+        }).compact
+      end
+
+      # @return [String, nil]
+      def system
+        messages = self.messages.filter { |message| message[:role].eql?(OmniAI::Chat::Role::SYSTEM) }
+        messages << { role: OmniAI::Chat::Role::SYSTEM, content: OmniAI::Chat::JSON_PROMPT } if @format.eql?(:json)
+
+        messages.map { |message| message[:content] }.join("\n\n") if messages.any?
+      end
+
+      # @return [String]
+      def path
+        "/#{OmniAI::Anthropic::Client::VERSION}/messages"
+      end
+    end
+  end
+end

data/lib/omniai/anthropic/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Anthropic
+    # An Anthropic client implementation. Usage:
+    #
+    # w/ `api_key``:
+    #   client = OmniAI::Anthropic::Client.new(api_key: '...')
+    #
+    # w/ ENV['ANTHROPIC_API_KEY']:
+    #
+    #   ENV['ANTHROPIC_API_KEY'] = '...'
+    #   client = OmniAI::Anthropic::Client.new
+    #
+    # w/ config:
+    #
+    #   OmniAI::Anthropic.configure do |config|
+    #     config.api_key = '...'
+    #   end
+    #
+    #   client = OmniAI::Anthropic::Client.new
+    class Client < OmniAI::Client
+      VERSION = 'v1'
+
+      # @param api_key [String] optional - defaults to `OmniAI::Anthropic.config.api_key`
+      # @param host [String] optional - defaults to `OmniAI::Anthropic.config.host`
+      def initialize(
+        api_key: OmniAI::Anthropic.config.api_key,
+        version: OmniAI::Anthropic.config.version,
+        logger: OmniAI::Anthropic.config.logger,
+        host: OmniAI::Anthropic.config.host
+      )
+        raise(ArgumentError, %(ENV['ANTHROPIC_API_KEY'] must be defined or `api_key` must be passed)) if api_key.nil?
+
+        super(api_key:, logger:)
+
+        @host = host
+        @version = version
+      end
+
+      # @return [HTTP::Client]
+      def connection
+        HTTP
+          .headers('x-api-key': @api_key)
+          .headers('anthropic-version': @version)
+          .persistent('https://api.anthropic.com')
+      end
+
+      # @raise [OmniAI::Error]
+      #
+      # @param messages [String, Array, Hash]
+      # @param model [String] optional
+      # @param format [Symbol] optional :text or :json
+      # @param temperature [Float, nil] optional
+      # @param stream [Proc, nil] optional
+      #
+      # @return [OmniAI::Chat::Completion]
+      def chat(messages, model: Chat::Model::HAIKU, temperature: nil, format: nil, stream: nil)
+        Chat.process!(messages, model:, temperature:, format:, stream:, client: self)
+      end
+    end
+  end
+end

data/lib/omniai/anthropic/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Anthropic
+    # Config for the Anthropic `api_key` / `host` / `logger` / `version` / `chat_options`.
+    class Config < OmniAI::Config
+      attr_accessor :version, :chat_options
+
+      def initialize
+        super
+        @api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
+        @host = ENV.fetch('ANTHROPIC_HOST', 'https://api.anthropic.com')
+        @version = ENV.fetch('ANTHROPIC_VERSION', '2023-06-01')
+        @chat_options = { max_tokens: 4096 }
+      end
+    end
+  end
+end

data/lib/omniai/anthropic/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Anthropic
-    VERSION = "0.1.0"
+    VERSION = '1.0.1'
   end
 end

data/lib/omniai/anthropic.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "anthropic/version"
+require 'event_stream_parser'
+require 'omniai'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir(__dir__, namespace: OmniAI)
+loader.setup
 
 module OmniAI
+  # A namespace for everything Anthropic.
   module Anthropic
-    class Error < StandardError; end
-    # Your code goes here...
+    # @return [OmniAI::Anthropic::Config]
+    def self.config
+      @config ||= Config.new
+    end
+
+    # @yield [OmniAI::Anthropic::Config]
+    def self.configure
+      yield config
+    end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: omniai-anthropic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: omniai
+  name: event_stream_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: omniai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,16 +59,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
+- Gemfile
 - README.md
-- Rakefile
 - lib/omniai/anthropic.rb
+- lib/omniai/anthropic/chat.rb
+- lib/omniai/anthropic/chat/completion.rb
+- lib/omniai/anthropic/chat/stream.rb
+- lib/omniai/anthropic/client.rb
+- lib/omniai/anthropic/config.rb
 - lib/omniai/anthropic/version.rb
-- sig/omniai/anthropic.rbs
 homepage: https://github.com/ksylvest/omniai-anthropic
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ksylvest/omniai-anthropic
+  changelog_uri: https://github.com/ksylvest/omniai-anthropic/releases
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -77,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,8 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/sig/omniai/anthropic.rbs

@@ -1,6 +0,0 @@
-module Omniai
-  module Anthropic
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end