omniai 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54cb0309adb2c49473342a47f964d2ddb8035a42d8d8fe1d9fa6960ac0987cf4
-  data.tar.gz: 5f6792e26172ad6383308cd98501d6b53f4607411efba7317d90c6525fbb2473
+  metadata.gz: 8d54c88d48becdd4c496114b93841cf6dd32ba294a5cbf9828a0d0d4d28a023e
+  data.tar.gz: 8f8bb67797a1fa993cd5dc202d60e78c041ec184cf8120eae170e1b821228c62
 SHA512:
-  metadata.gz: f065076a409f5acc450eb020edbeb840d1f66ece51085b8493e2663132210e38cf02d12709e5932ecdeef88f50c8e61541c9b0d676281e7cd22e397ae9cb4f30
-  data.tar.gz: c44b00b48485d903c9f44f63137367fc71a0bf97c38d1d80274f8a51073339125ddbfeb1a427bbd459b496e4fe1c8f7921c5e5c7534af1499a2471621c3be6d5
+  metadata.gz: 8f0a3651c5eb608d0aba74c8c8ae06d4def73fc519fc4cbef6c8b2a8c3434d00cd469e24eaafc8f07193cb028c93984e459c7ffc65e89e56bfc30e0ebc879a05
+  data.tar.gz: 21be334bdd435bfb7b9c449556cce86dde4e33dd0d84bcd285cb4b52e438ed93ca387356821f76bce3064f3bc31be3446f43773456156976d0f33fcdceb89243

data/Gemfile

@@ -0,0 +1,13 @@
+# 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'

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'omniai'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/omniai/chat/choice.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A choice returned by the API.
+    class Choice
+      attr_accessor :index, :message, :role
+
+      # @param index [Integer]
+      # @param message [OmniAI::Chat::Message]
+      # @param role [String]
+      def initialize(index:, message:)
+        @index = index
+        @message = message
+      end
+    end
+  end
+end

data/lib/omniai/chat/message.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A message returned by the API.
+    class Message
+      attr_accessor :index, :message, :role
+
+      # @param content [Integer]
+      # @param role [String]
+      def initialize(content:, role:)
+        @content = content
+        @role = role
+      end
+    end
+  end
+end

data/lib/omniai/chat/request.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # An abstract class that provides a consistent interface for processing chat requests.
+    #
+    # Usage:
+    #
+    #    class OmniAI::OpenAI::ChatGPT::Completion < OmniAI::Chat::Completion
+    #      module Model
+    #        CHAT = "davinci"
+    #      end
+    #      def completion(messages, model:, temperature: 0.0, format: :text)
+    #      end
+    #    end
+    #
+    # Once defined, the subclass can be used to interface with the vendor's chat API as follows:
+    #
+    #    client.chat.completion(messages, model: "...", temperature: 0.0, format: :text)
+    class Request
+      # @param client [OmniAI::Client] the client
+      # @param messages [String]
+      # @param model [String]
+      # @param temperature [Float]
+      # @param format [Symbol] either :text or :json
+      def initialize(client:, messages:, model:, temperature: 0.0, format: :text)
+        @client = client
+        @messages = messages
+        @model = model
+        @temperature = temperature
+        @format = format
+      end
+
+      # @param prompt [String, Message]
+      # @param model [String]
+      # @param format [Symbol] either :text or :json
+      # @param temperature [Float]
+      # @return [Hash]
+      # @raise [ExecutionError]
+      def process!
+        response = request!
+        raise HTTPError, response unless response.status.ok?
+
+        parse!(response:)
+      end
+
+      protected
+
+      # @param response [HTTP::Response]
+      # @return [OmniAI::Chat::Completion::Response]
+      def parse!(response:)
+        raise NotImplementedError, "#{self.class.name}#parse! undefined"
+      end
+
+      # @return [Hash]
+      def payload
+        raise NotImplementedError, "#{self.class.name}#payload undefined"
+      end
+
+      # @return [String]
+      def path
+        raise NotImplementedError, "#{self.class.name}#path undefined"
+      end
+
+      # @return [HTTP::Response]
+      def request!
+        @client
+          .connection
+          .accept(:json)
+          .post(path, json: payload)
+      end
+    end
+  end
+end

data/lib/omniai/chat/response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # An abstract class that provides a consistent interface for processing chat responses.
+    #
+    # Usage:
+    #
+    #   class OmniAI::OpenAI::Chat::Response < OmniAI::Chat::Response
+    #     def choices
+    #       # TODO: implement
+    #     end
+    #   end
+    class Response
+      attr_accessor :data
+
+      # @param data [Hash]
+      def initialize(data:)
+        @data = data
+      end
+
+      # @param [index] [Integer]
+      # @return [OmniAI::Chat::Choice]
+      def choice(index: 0)
+        choices[index]
+      end
+
+      # @return [Array<OmniAI::Chat::Choice>]
+      def choices
+        raise NotImplementedError, "#{self.class.name}#choices undefined"
+      end
+    end
+  end
+end

data/lib/omniai/chat.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OmniAI
+  # An abstract class that provides an interface for chatting for various vendors (e.g. OpenAI::ChatGPT).
+  #
+  # Usage:
+  #
+  #   class OmniAI::OpenAI::Chat < OmniAI::Chat
+  #     def completion(messages, model:, temperature: 0.0, format: :text)
+  #       # TODO: implement
+  #     end
+  #   end
+  #
+  # Once defined, it can be used to interface with the vendor's chat API as follows:
+  #
+  #   client.chat.completion("...", model: "...", temperature: 0.0, format: :text)
+  #
+  # @param client [OmniAI::Client] the client
+  class Chat
+    def initialize(client:)
+      @client = client
+    end
+
+    # @raise [OmniAI::Error]
+    #
+    # @param messages [String]
+    # @param model [String]
+    # @param format [Symbol] either :text or :json
+    # @param temperature [Float]
+    #
+    # @return [OmniAI::Chat::Request]
+    def completion(messages, model:, temperature: 0.0, format: :text)
+      raise NotImplementedError, "#{self.class.name}#completion undefined"
+    end
+  end
+end

data/lib/omniai/client.rb

@@ -1,27 +1,38 @@
 # frozen_string_literal: true
 
-# Usage:
-#
-#   require "omniai"
-#   require "omniai-anthropic"
-#   require "omniai-google"
-#   require "omniai-mistral"
-#   require "omniai-openai"
-#
-#   anthropic = OmniAI::Anthropic.new(api_key: ENV.fetch("OPENAI_API_KEY"))
-#   google = OmniAI::Google.new(api_key: ENV.fetch("OPENAI_API_KEY"))
-#   mistral = OmniAI::Mistral.new(api_key: ENV.fetch("OPENAI_API_KEY"))
-#   openai = OmniAI::OpenAI.new(api_key: ENV.fetch("OPENAI_API_KEY"))
+module OmniAI
+  # An abstract class that must be subclassed (e.g. OmniAI::OpenAI::Client).
+  #
+  # Usage:
+  #
+  #   class OmniAI::OpenAI::Client < OmniAI::Client
+  #     def initialize(api_key: ENV.fetch('OPENAI_API_KEY'))
+  #       super
+  #     end
+  #
+  #     @return [OmniAI::OpenAI::Chat]
+  #     def chat
+  #       # TODO: implement
+  #     end
+  #   end
+  class Client
+    class Error < StandardError; end
 
-module OmniAI::Client
-  class Error < StandardError; end
+    attr_accessor :api_key
 
-  # @param api_key [String] The API key to use for requests
-  def initialize(api_key:)
-    @api_key = api_key
-  end
+    # @param api_key [String]
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    # @return [HTTP::Client]
+    def connection
+      HTTP.auth("Bearer #{api_key}")
+    end
 
-  def http
-    HTTP.auth("Bearer #{@api_key}")
+    # @return [OmniAI::Chat] an instance of OmniAI::Chat
+    def chat
+      raise NotImplementedError, "#{self.class.name}#chat undefined"
+    end
   end
 end

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = "0.0.1"
+  VERSION = '0.0.3'
 end

data/lib/omniai.rb

@@ -1,7 +1,23 @@
 # frozen_string_literal: true
 
-require_relative "omniai/version"
+require 'http'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect 'omniai' => 'OmniAI'
+loader.setup
 
 module OmniAI
   class Error < StandardError; end
+
+  # An error that wraps an HTTP::Response for non-OK requests.
+  class HTTPError < Error
+    attr_accessor :response
+
+    # @param response [HTTP::Response]
+    def initialize(response)
+      super("status=#{response.status} headers=#{response.headers} body=#{response.body}")
+      @response = response
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -25,52 +25,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Gives a consistent interface for interacting with OpenAI's ChatGPT, Google's
-  Gemini, Anthropic's Claude, Mistral's LeChat, and more.
+description: An interface for OpenAI's ChatGPT, Google's Gemini, Anthropic's Claude,
+  Mistral's LeChat, etc.
 email:
 - kevin@ksylvest.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
+- Gemfile
 - README.md
-- Rakefile
+- bin/console
+- bin/setup
 - lib/omniai.rb
+- lib/omniai/chat.rb
+- lib/omniai/chat/choice.rb
+- lib/omniai/chat/message.rb
+- lib/omniai/chat/request.rb
+- lib/omniai/chat/response.rb
 - lib/omniai/client.rb
 - lib/omniai/version.rb
-- sig/omniai.rbs
 homepage: https://github.com/ksylvest/omniai
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ksylvest/omniai
+  changelog_uri: https://github.com/ksylvest/omniai/releases
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -79,7 +72,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,2 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.0

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.rbs

@@ -1,3 +0,0 @@
-module OmniAI
-  VERSION: String
-end