omniai 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b37e667b2b004a012bf7d7d76fd80c08aa8948d46b8670651daa3a426c591d2
-  data.tar.gz: ded01ccbbf34486159fd965953a9d5cec9a62da16404960e5b0c8bca8d5384ad
+  metadata.gz: 2820bc43050fa4484a25e1a967b3d12ac71a3d5659e735f5904040990acf47b8
+  data.tar.gz: 8894714bf0c8055ca173176d8eeb078ce6f93a0481c19df3fd2dae911fbb264d
 SHA512:
-  metadata.gz: c6c26067f0b0b3c7ecefbdc00ed1746f0f597f729a41ff1e0a253bb723cf89ef1b82ccc2c411a8b43b93d5f54c83a9f3e58ab7074be324e9b3bf24e099e7ca2a
-  data.tar.gz: fe75154f85d6a68b1698c923548570695c724293462225bdb9d29db8ccf884ab2965bce3090a9f9c64851c5547ab4a655e59e7079c0923bff9ee18f46320517c
+  metadata.gz: b2658cb0bf197315f3679225a214871ffdbf670cabb65f3126b4a1e7ccd40b6f38810e9fea828b71eb1c9fae819f94e824dedc65ed69cc7531e496d9ae027896
+  data.tar.gz: 3f525900c8c319076549235713418e7cc7e87167151668900e3073530004b9bb1561469a9b02914dfac63eff4f35b67fbf9ca66171b5471cf24c665e280f3d23

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/chunk.rb

@@ -31,9 +31,9 @@ module OmniAI
         @data['model']
       end
 
-      # @return [Array<OmniAI::Chat::Choice>]
+      # @return [Array<OmniAI::Chat::DeltaChoice>]
       def choices
-        @choices ||= @data['choices'].map { |data| Choice.for(data:) }
+        @choices ||= @data['choices'].map { |data| DeltaChoice.for(data:) }
       end
 
       # @param index [Integer]

data/lib/omniai/chat/completion.rb

@@ -38,13 +38,13 @@ module OmniAI
         @usage ||= Usage.for(data: @data['usage'])
       end
 
-      # @return [Array<OmniAI::Chat::Choice>]
+      # @return [Array<OmniAI::Chat::MessageChoice>]
       def choices
-        @choices ||= @data['choices'].map { |data| Choice.for(data:) }
+        @choices ||= @data['choices'].map { |data| MessageChoice.for(data:) }
       end
 
       # @param index [Integer] optional - default is 0
-      # @return [OmniAI::Chat::Choice]
+      # @return [OmniAI::Chat::MessageChoice]
       def choice(index: 0)
         choices[index]
       end

data/lib/omniai/chat/delta_choice.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A delta choice returned by the API.
+    class DeltaChoice
+      attr_accessor :index, :delta
+
+      # @param data [Hash]
+      # @return [OmniAI::Chat::Choice]
+      def self.for(data:)
+        index = data['index']
+        delta = Delta.for(data: data['delta'])
+
+        new(index:, delta:)
+      end
+
+      # @param index [Integer]
+      # @param delta [Delta]
+      def initialize(index:, delta:)
+        @index = index
+        @delta = delta
+      end
+    end
+  end
+end

data/lib/omniai/chat/message_choice.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OmniAI
+  class Chat
+    # A choice returned by the API.
+    class MessageChoice
+      attr_accessor :index, :message
+
+      # @param data [Hash]
+      # @return [OmniAI::Chat::Choice]
+      def self.for(data:)
+        index = data['index']
+        message = Message.for(data: data['message'])
+
+        new(index:, message:)
+      end
+
+      # @param index [Integer]
+      # @param message [OmniAI::Chat::Message]
+      def initialize(index:, message:)
+        @index = index
+        @message = message
+      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.1'
+  VERSION = '1.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -66,7 +66,6 @@ files:
 - bin/setup
 - lib/omniai.rb
 - lib/omniai/chat.rb
-- lib/omniai/chat/choice.rb
 - lib/omniai/chat/chunk.rb
 - lib/omniai/chat/completion.rb
 - lib/omniai/chat/content/file.rb
@@ -74,7 +73,9 @@ files:
 - lib/omniai/chat/content/text.rb
 - lib/omniai/chat/content/url.rb
 - lib/omniai/chat/delta.rb
+- lib/omniai/chat/delta_choice.rb
 - lib/omniai/chat/message.rb
+- lib/omniai/chat/message_choice.rb
 - lib/omniai/chat/stream.rb
 - lib/omniai/chat/usage.rb
 - lib/omniai/client.rb

data/lib/omniai/chat/choice.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module OmniAI
-  class Chat
-    # A choice returned by the API.
-    class Choice
-      attr_accessor :index, :delta, :message
-
-      # @param data [Hash]
-      # @return [OmniAI::Chat::Choice]
-      def self.for(data:)
-        index = data['index']
-        delta = Delta.for(data: data['delta']) if data['delta']
-        message = Message.for(data: data['message']) if data['message']
-
-        new(index:, delta:, message:)
-      end
-
-      # @param index [Integer]
-      # @param delta [OmniAI::Chat::Delta] optional
-      # @param message [OmniAI::Chat::Message] optional
-      def initialize(index:, delta:, message:)
-        @index = index
-        @delta = delta
-        @message = message
-      end
-    end
-  end
-end