omniai 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7214249d8bda8299971c31dace84132a52f64b1464ff4d28af27f4a0f93221f8
-  data.tar.gz: c52f1ef0038da9fc26901f1838d2497e26febcf564548101a96acf03c49c6aa4
+  metadata.gz: 4e387dddb26068bab8b4aa35a8e990d6db7aed7f034ae4593105b680282e5d43
+  data.tar.gz: 20f9b49d315dea539937521507058a16b8d6f8b0aaeea26f1b6be2cacf07122c
 SHA512:
-  metadata.gz: a922ecde2f712428565fa4b0f4544c26249f9c0a85f5801c2b4029d15650d80edca3fae70fb81356c5c66ddce681ffca544c77d3255ac02c335071d9a5b7db4b
-  data.tar.gz: 53756ecbb1aa2cdbad35c36f9f8b25803e7065661ab2e02716f28f44d7cab3dd9e253bcf6d1fc94dcfaa8d57a27b5f25ed8447c3e50b9d884d1d08fae72ddc75
+  metadata.gz: 8c3f503fe81921c2d690f169bc22d3d55b00b590920dc31c47c625a93dd142c995e369a9ffa3675c82bf7d04d3861e3b6e09b98b6e3afbd72bfed91b606e8473
+  data.tar.gz: 443d264b0f4c39058fd759b379e604cb631435334fff5fe7528b06cf8502af40c2fbfdca86300e5135029e90ab6104bb0c2b86e5198bd69fcd9c8071e6fbc07a

data/README.md

@@ -60,19 +60,57 @@ client = OmniAI::OpenAI::Client.new
 
 ### Chat
 
-Clients that support chat (e.g. Anthropic w/ "Claude", Google w/ "Gemini", Mistral w/ "LeChat", OpenAI w/ "ChatGPT", etc) can generate completions using either a basic or streaming API:
+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:
 
-#### Basic
+#### w/ a Simple Prompt
 
 ```ruby
 completion = client.chat.completion('Tell me a joke.')
 puts(completion.choice.message.content) # '...'
 ```
 
+#### w/ a Collection of Messages
+
+```ruby
+messages = [
+  {
+    role: 'system',
+    content: 'You are a helpful assistant with an expertise in geography.',
+  },
+  {
+    role: 'user',
+    content: 'What is the capital of Canada?',
+  },
+]
+completion = client.chat.completion(messages, model: '...', temperature: 0.7, format: :json)
+puts(completion.choice.message.content) # '...'
+```
+
+#### w/ a Collection of Files
+
+```ruby
+
+image_a_url = "https://images.unsplash.com/photo-1517849845537-4d257902454a?w=800&h=800&format=jpeg&fit=crop"
+image_b_url = "https://images.unsplash.com/photo-1537151625747-768eb6cf92b2?q=80&w=1024&h=1024&format=jpeg"
+
+message = {
+  role: 'user',
+  content: [
+    OmniAI::Chat::Content.new('What are in these images and are they different?'),
+    OmniAI::Chat::Content.new(image_a_url, type: :image),
+    OmniAI::Chat::Content.new(image_b_url, type: :image),
+  ]
+}
+
+completion = client.chat.completion(message)
+puts(completion.choice.message.content) # '...'
+```
+
 #### Streaming
 
 ```ruby
-client.chat.completion 'Tell me a joke.', stream: proc do |chunk|
+stream = proc do |chunk|
   print(chunk.choice.delta.content) # '...'
 end
+client.chat.completion('Tell me a joke.', stream:)
 ```

data/lib/omniai/chat/content.rb

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

data/lib/omniai/chat/request.rb

@@ -6,7 +6,7 @@ module OmniAI
     #
     # Usage:
     #
-    #    class OmniAI::OpenAI::ChatGPT::Completion < OmniAI::Chat::Completion
+    #    class OmniAI::OpenAI::ChatGPT::Request < OmniAI::Chat::Request
     #      module Model
     #        CHAT = "davinci"
     #      end
@@ -23,7 +23,7 @@ module OmniAI
       # @param model [String] required
       # @param temperature [Float, nil] optional
       # @param stream [Proc, nil] optional
-      # @param format [Symbol, nil] optional - :text or :json
+      # @param format [Symbol, nil] optional - :json
       def initialize(client:, messages:, model:, temperature: nil, stream: nil, format: nil)
         @client = client
         @messages = messages
@@ -44,12 +44,12 @@ module OmniAI
       protected
 
       # @param response [HTTP::Response]
-      # @return [OmniAI::Chat::Completion::Response]
+      # @return [OmniAI::Chat::Completion]
       def parse!(response:)
         if @stream
           stream!(response:)
         else
-          OmniAI::OpenAI::Chat::Completion.new(data: response.parse)
+          OmniAI::Chat::Completion.new(data: response.parse)
         end
       end
 
@@ -62,7 +62,7 @@ module OmniAI
           parser.feed(chunk) do |_, data|
             break if data.eql?('[DONE]')
 
-            chunk = OmniAI::OpenAI::Chat::Chunk.new(data: JSON.parse(data))
+            chunk = OmniAI::Chat::Chunk.new(data: JSON.parse(data))
             @stream.call(chunk)
           end
         end

data/lib/omniai/config.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OmniAI
+  # A configuration for each agent w/ `api_key` / `host` / `logger`.
+  class Config
+    attr_accessor :api_key, :host, :logger
+  end
+end

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -16,7 +16,7 @@ module OmniAI
 
     # @param response [HTTP::Response]
     def initialize(response)
-      super("status=#{response.status.inspect} headers=#{response.headers.inspect} body=#{response.body.inspect}")
+      super("status=#{response.status.inspect} headers=#{response.headers.inspect} body=#{response.body}")
       @response = response
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -69,11 +69,13 @@ files:
 - lib/omniai/chat/choice.rb
 - lib/omniai/chat/chunk.rb
 - lib/omniai/chat/completion.rb
+- lib/omniai/chat/content.rb
 - lib/omniai/chat/delta.rb
 - lib/omniai/chat/message.rb
 - lib/omniai/chat/request.rb
 - lib/omniai/chat/usage.rb
 - lib/omniai/client.rb
+- lib/omniai/config.rb
 - lib/omniai/version.rb
 homepage: https://github.com/ksylvest/omniai
 licenses: []