omniai 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a5db8ecb28e379812a5dce657588fb44c55b7af4b8a2463bdb712d91b9f0a9
-  data.tar.gz: 3d5a935c85975fb46a5062c8a4999c0f1fcdb187f2aa542863a4503791dc095b
+  metadata.gz: 8d54c88d48becdd4c496114b93841cf6dd32ba294a5cbf9828a0d0d4d28a023e
+  data.tar.gz: 8f8bb67797a1fa993cd5dc202d60e78c041ec184cf8120eae170e1b821228c62
 SHA512:
-  metadata.gz: 4846e70507f51344862e5382ffcf5043b4896408eff86377d75af7439bd5cb6d865a19b84f67ae87be686c9c0be9e1005d3321896a3083ea2a0d208e051a2a6b
-  data.tar.gz: ab185c7be3efffc942c9eb104f4ad77bec9847718f0ee91456e2fd57cd1fd2ca3206fc73f601ba964084bb0c6aa3450da17c8280c53592fa363854d19640faae
+  metadata.gz: 8f0a3651c5eb608d0aba74c8c8ae06d4def73fc519fc4cbef6c8b2a8c3434d00cd469e24eaafc8f07193cb028c93984e459c7ffc65e89e56bfc30e0ebc879a05
+  data.tar.gz: 21be334bdd435bfb7b9c449556cce86dde4e33dd0d84bcd285cb4b52e438ed93ca387356821f76bce3064f3bc31be3446f43773456156976d0f33fcdceb89243

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/{completion.rb → request.rb}

@@ -2,7 +2,7 @@
 
 module OmniAI
   class Chat
-    # An abstract class that provides an interface for chatting for various vendors (e.g. OpenAI::OpenAI::ChatGPT::Completion).
+    # An abstract class that provides a consistent interface for processing chat requests.
     #
     # Usage:
     #
@@ -17,7 +17,7 @@ module OmniAI
     # 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 Completion
+    class Request
       # @param client [OmniAI::Client] the client
       # @param messages [String]
       # @param model [String]

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

@@ -22,11 +22,13 @@ module OmniAI
     end
 
     # @raise [OmniAI::Error]
+    #
     # @param messages [String]
     # @param model [String]
     # @param format [Symbol] either :text or :json
     # @param temperature [Float]
-    # @return [OmniAI::Chat::Completion] an instance of OmniAI::Chat::Completion
+    #
+    # @return [OmniAI::Chat::Request]
     def completion(messages, model:, temperature: 0.0, format: :text)
       raise NotImplementedError, "#{self.class.name}#completion undefined"
     end

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require 'http'
+require 'zeitwerk'
 
-require_relative 'omniai/version'
-require_relative 'omniai/client'
-require_relative 'omniai/chat'
-require_relative 'omniai/chat/completion'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect 'omniai' => 'OmniAI'
+loader.setup
 
 module OmniAI
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An interface for OpenAI's ChatGPT, Google's Gemini, Anthropic's Claude,
   Mistral's LeChat, etc.
 email:
@@ -38,15 +52,16 @@ files:
 - bin/setup
 - lib/omniai.rb
 - lib/omniai/chat.rb
-- lib/omniai/chat/completion.rb
-- lib/omniai/chat/completion/response.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
 homepage: https://github.com/ksylvest/omniai
 licenses: []
 metadata:
   homepage_uri: https://github.com/ksylvest/omniai
-  source_code_uri: https://github.com/ksylvest/omniai
   changelog_uri: https://github.com/ksylvest/omniai/releases
   rubygems_mfa_required: 'true'
 post_install_message: