omniai 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6114f0ef4a95633c3391eb421c23e8df99413c876b838053ddb89bde4e7d6f0
-  data.tar.gz: fe2156f9db8802f44975cc1aab0a58f34cb568e1b34fe14e33bd34c52f4b6ff9
+  metadata.gz: 239eb058ae53afd3f28fe00a18af282a856ca842a4f81bcdf22413a02d8d44fc
+  data.tar.gz: e74ac69ab6435fd9da3d1602c9cce5e052f53bebf609d8815868b58be0897884
 SHA512:
-  metadata.gz: 2e3a7b49bd65210142978e79ccb9ed88cd19b085c48334b16939c1401217913b951d474515d2ac3fedd1984cc1c7e31e9fa2af206ee04da3765eb1cfb8e2b393
-  data.tar.gz: 7d966a598e0ec358785e25be08530f7f82898601030f703c78a728e31e7885841239d50c1c851ef3912060318df588050ddf7f35870f5f97254e9a23f412b045
+  metadata.gz: a6b18cae8b5aab610bf255860ccd514b794eda3021b2f9b3aa86020968e0f449b683b4db74291e71583698b61d7612a7e49b3ee0310c806a826f7b27c50c7d92
+  data.tar.gz: bd12b38f3c9a150fe09644aaf187aa05aa1063ee136196e11fcaa356f4fe5bdc2c93f6292a79025f301c6d35a1202186f6ad787787828dfd5af91f229a34b550

data/README.md

@@ -60,6 +60,18 @@ require 'omniai/openai'
 client = OmniAI::OpenAI::Client.new
 ```
 
+#### Usage with LocalAI
+
+LocalAI support is offered through [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai):
+
+[Usage with LocalAI](https://github.com/ksylvest/omniai-openai#usage-with-localai)
+
+#### Usage with Ollama
+
+Ollama support is offered through [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai):
+
+[Usage with Ollama](https://github.com/ksylvest/omniai-openai#usage-with-ollama)
+
 ### Chat
 
 Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistral w/ "LeChat", OpenAI w/ "ChatGPT", etc) generate completions using the following calls:

data/lib/omniai/chat/content/file.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Content
+      # A file that is either audio / image / video.
+      class File < Media
+        attr_accessor :io
+
+        # @param io [IO, Pathname, String]
+        # @param type [Symbol, String] :image, :video, :audio, "audio/flac", "image/jpeg", "video/mpeg", etc.
+        def initialize(io, type)
+          super(type)
+          @io = io
+        end
+
+        # @return [String]
+        def fetch!
+          case @io
+          when IO then @io.read
+          else ::File.binread(@io)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/content/media.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Content
+      # An abstract class that represents audio / image / video and is used for both files and urls.
+      class Media
+        attr_accessor :type
+
+        # @param type [String] "audio/flac", "image/jpeg", "video/mpeg", etc.
+        def initialize(type)
+          @type = type
+        end
+
+        # @return [Boolean]
+        def text?
+          @type.match?(%r{^text/})
+        end
+
+        # @return [Boolean]
+        def audio?
+          @type.match?(%r{^audio/})
+        end
+
+        # @return [Boolean]
+        def image?
+          @type.match?(%r{^image/})
+        end
+
+        # @return [Boolean]
+        def video?
+          @type.match?(%r{^video/})
+        end
+
+        # @yield [io]
+        def fetch!(&)
+          raise NotImplementedError, "#{self.class}#fetch! undefined"
+        end
+
+        # e.g. "Hello" -> "SGVsbG8h"
+        #
+        # @return [String]
+        def data
+          Base64.strict_encode64(fetch!)
+        end
+
+        # e.g. "data:text/html;base64,..."
+        #
+        # @return [String]
+        def data_uri
+          "data:#{@type};base64,#{data}"
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/content/text.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Content
+      # Just some text.
+      class Text
+        attr_accessor :text
+
+        # @param text [text]
+        def initialize(text)
+          @text = text
+        end
+      end
+    end
+  end
+end

data/lib/omniai/chat/content/url.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    module Content
+      # A url that is either audio / image / video.
+      class URL < Media
+        attr_accessor :url, :type
+
+        class HTTPError < OmniAI::HTTPError; end
+
+        # @param url [URI, String]
+        # @param type [Symbol, String] "audio/flac", "image/jpeg", "video/mpeg", etc.
+        def initialize(url, type)
+          super(type)
+          @url = url
+        end
+
+        # @raise [HTTPError]
+        #
+        # @return [String]
+        def fetch!
+          response = request!
+          String(response.body)
+        end
+
+        private
+
+        # @raise [HTTPError]
+        #
+        # @return [HTTP::Response]
+        def request!
+          response = HTTP.get(@url)
+          raise HTTPError, response.flush unless response.status.success?
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/omniai/client.rb

@@ -13,19 +13,28 @@ module OmniAI
   class Client
     class Error < StandardError; end
 
-    attr_accessor :api_key
+    attr_accessor :api_key, :logger, :host
 
-    # @param api_key [String]
-    # @param logger [Logger]
-    def initialize(api_key:, logger: nil)
+    # @param api_key [String] optional
+    # @param host [String] optional - supports for customzing the host of the client (e.g. 'http://localhost:8080')
+    # @param logger [Logger] optional
+    def initialize(api_key: nil, logger: nil, host: nil)
       @api_key = api_key
+      @host = host
       @logger = logger
     end
 
     # @return [String]
     def inspect
-      masked_api_key = "#{api_key[..2]}***" if api_key
-      "#<#{self.class.name} api_key=#{masked_api_key.inspect}>"
+      props = []
+      props << "api_key=#{masked_api_key.inspect}" if @api_key
+      props << "host=#{@host.inspect}" if @host
+      "#<#{self.class.name} #{props.join(' ')}>"
+    end
+
+    # @return [String]
+    def masked_api_key
+      "#{api_key[..2]}***" if api_key
     end
 
     # @return [HTTP::Client]

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -2,10 +2,12 @@
 
 require 'event_stream_parser'
 require 'http'
+require 'uri'
 require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect 'omniai' => 'OmniAI'
+loader.inflector.inflect 'url' => 'URL'
 loader.setup
 
 module OmniAI

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Kevin Sylvestre
@@ -69,7 +69,10 @@ files:
 - lib/omniai/chat/choice.rb
 - lib/omniai/chat/chunk.rb
 - lib/omniai/chat/completion.rb
-- lib/omniai/chat/content.rb
+- lib/omniai/chat/content/file.rb
+- lib/omniai/chat/content/media.rb
+- lib/omniai/chat/content/text.rb
+- lib/omniai/chat/content/url.rb
 - lib/omniai/chat/delta.rb
 - lib/omniai/chat/message.rb
 - lib/omniai/chat/stream.rb

data/lib/omniai/chat/content.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A file used for analysis.
-    class Content
-      attr_accessor :type, :value
-
-      # @param value [String]
-      # @param type [Symbol] :image / :video / :audio / :text
-      def initialize(value, type: :text)
-        @value = value
-        @type = type
-      end
-    end
-  end
-end