omniai 1.9.5 → 1.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57a422d4d3213f3d952940908890c4da086668972a6596f4ce69530af1bf547
-  data.tar.gz: a66bb5326ce64219cc58ab1f072ef40741ae03a83aecd86d96a6417767911c5b
+  metadata.gz: 23098dd1fbbb9542265f3d32a9c37642a1a554fa4a789c78fb4e25a364213116
+  data.tar.gz: 4885f37cc46af15c1e208a6c9c4f0f06b84d4986c1d0b9361fd2b9e451fb3352
 SHA512:
-  metadata.gz: 832c57105c19df9bf3675a1050cae1bdb775cd117a4222b81ee7032abf5356007fa04f7282017585da7563855d0e6ddc55aa8f330a9dfdceb22b0b9f632c2f96
-  data.tar.gz: d202c4bc08eaefa7b5ec08c3192c0fa08f6938fbd3feade8018d65c4a46cb56d078194b072b2b483388c6fca736fa334e3f717fb14d607123425ce250f969488
+  metadata.gz: a63e630e0aeeeb8342cceba0d2505c487e9dacfcd76bcc07e75d8c29c132a9806d3d4fdc4346ebcd6a6eb02534a14de75f9bd5530388eec1652ff19a61b2d008
+  data.tar.gz: a61425c68913a53de2d0300fe3c74ea546491f69fffd53c1c6fbd414924b7204b718c7676de5b604a063532a8149bbaef132032b1cbc49ac0e69d9030bfd456e

data/README.md

@@ -6,7 +6,7 @@
 [![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://omniai.ksylvest.com)
 [![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/omniai)](https://circleci.com/gh/ksylvest/omniai)
 
-OmniAI standardizes the APIs of various AI / LLM companies such as Anthropic, Google, Mistral and OpenAI for the generation of text, the conversion of text-to-speech, the conversion of speech-to-text, the generation of embeddings, and more. It offers a unified API regardless of the provider and task.
+OmniAI provides a unified Ruby API for integrating with multiple AI providers, including Anthropic, DeepSeek, Google, Mistral, and OpenAI. It streamlines AI development by offering a consistent interface for features such as chat, text-to-speech, speech-to-text, and embeddings—ensuring seamless interoperability across platforms. Switching between providers is effortless, making any integration more flexible and reliable.
 
 - [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 - [OmniAI::DeepSeek](https://github.com/ksylvest/omniai-deepseek)
@@ -18,6 +18,8 @@ OmniAI standardizes the APIs of various AI / LLM companies such as Anthropic, Go
 
 ### Example #1: [Chat](https://github.com/ksylvest/omniai/blob/main/examples/chat)
 
+This example demonstrates using `OmniAI` with **Anthropic** to prompt a “biologist” for an analysis of photos, identifying the animals within each one. A system and user message are provided, and the response is streamed in real time.
+
 ```ruby
 require 'omniai/anthropic'
 
@@ -45,6 +47,8 @@ The animals in the photos are:
 
 ### Example #2: [Text-to-Speech](https://github.com/ksylvest/omniai/blob/main/examples/text_to_speech)
 
+This example demonstrates using `OmniAI` with **OpenAI** to convert text to speech and save it to a file.
+
 ```ruby
 require 'omniai/openai'
 
@@ -59,6 +63,8 @@ end
 
 ### Example #3: [Speech-to-Text](https://github.com/ksylvest/omniai/blob/main/examples/speech_to_text)
 
+This example demonstrates using `OmniAI` with **OpenAI** to convert speech to text.
+
 ```ruby
 require 'omniai/openai'
 
@@ -72,6 +78,8 @@ end
 
 ### Example #4: [Tools](https://github.com/ksylvest/omniai/blob/main/examples/tools)
 
+This example demonstrates how to use `OmniAI` with **Google** to call a custom tool that generates a weather report. The tool accepts a list of locations (city and country) and returns a temperature — randomly generated for demonstration purposes — based on the provided parameters.
+
 ```ruby
 require 'omniai/google'
 
@@ -127,6 +135,8 @@ The weather is 24° celcius in London and 42° fahrenheit in Seattle.
 
 ### Example #5: [Embeddings](https://github.com/ksylvest/omniai/blob/main/examples/embeddings)
 
+This example demonstrates using `OmniAI` with **Mistral** to generate embeddings for a dataset. It defines a set of entries (e.g. "George is a teacher." or "Ringo is a doctor.") and then compares the embeddings generated from a query (e.g. "What does George do?" or "Who is a doctor?") to rank the entries by relevance.
+
 ```ruby
 require 'omniai/mistral'
 

data/lib/omniai/chat/choice.rb

@@ -5,15 +5,20 @@ module OmniAI
     # A choice wraps a message and index returned by an LLM. The default is to generate a single choice. Some LLMs
     # support generating multiple choices at once (e.g. giving you multiple options to choose from).
     class Choice
-      # @return [Integer]
+      DEFAULT_INDEX = 0
+      private_constant :DEFAULT_INDEX
+
+      # @!attribute [rw] index
+      #   @return [Integer]
       attr_accessor :index
 
-      # @return [Message]
+      # @!attribute [rw] message
+      #   @return [Message]
       attr_accessor :message
 
       # @param message [Message]
       # @param index [Integer]
-      def initialize(message:, index: 0)
+      def initialize(message:, index: DEFAULT_INDEX)
         @message = message
         @index = index
       end
@@ -31,7 +36,7 @@ module OmniAI
         deserialize = context&.deserializer(:choice)
         return deserialize.call(data, context:) if deserialize
 
-        index = data["index"]
+        index = data["index"] || DEFAULT_INDEX
         message = Message.deserialize(data["message"] || data["delta"], context:)
 
         new(message:, index:)
@@ -49,6 +54,13 @@ module OmniAI
         }
       end
 
+      # @param other [OmniAI::Chat::Choice]
+      #
+      # @return [OmniAI::Chat::Choice]
+      def merge(other)
+        self.class.new(index: @index, message: @message.merge(other.message))
+      end
+
       # @return [Message]
       def delta
         message

data/lib/omniai/chat/file.rb

@@ -4,6 +4,8 @@ module OmniAI
   class Chat
     # A file is media that can be sent to many LLMs.
     class File < Media
+      # @!attribute [rw] io
+      #   @return [IO, Pathname, String]
       attr_accessor :io
 
       # @param io [IO, Pathname, String]

data/lib/omniai/chat/message.rb

@@ -38,13 +38,16 @@ module OmniAI
         end
       end
 
-      # @return [Array<Content>, String]
+      # @!attribute [rw] content
+      #   @return [Array<Content>, String]
       attr_accessor :content
 
-      # @return [String]
+      # @!attribute [rw] role
+      #   @return [String]
       attr_accessor :role
 
-      # @return [Array<ToolCall>, nil]
+      # @!attribute [rw] tool_call_list
+      #   @return [Array<ToolCall>, nil]
       attr_accessor :tool_call_list
 
       # @param content [String, nil]
@@ -106,6 +109,27 @@ module OmniAI
         { role: @role, content:, tool_calls: }.compact
       end
 
+      # @param other [OmniAI::Chat::Message]
+      #
+      # @return [OmniAI::Chat::Message]
+      def merge(other)
+        content =
+          if @content && other.content
+            @content + other.content
+          else
+            @content || other.content
+          end
+
+        tool_call_list =
+          if @tool_call_list && other.tool_call_list
+            @tool_call_list + other.tool_call_list
+          else
+            @tool_call_list || other.tool_call_list
+          end
+
+        self.class.new(content:, role:, tool_call_list:)
+      end
+
       # @return [Boolean]
       def role?(role)
         String(@role).eql?(String(role))

data/lib/omniai/chat/payload.rb

@@ -12,7 +12,8 @@ module OmniAI
 
       # @param choices [Array<Choice>]
       # @param usage [Usage, nil]
-      def initialize(choices:, usage: nil)
+      def initialize(choices: [], usage: nil)
+        @id = SecureRandom.alphanumeric
         @choices = choices
         @usage = usage
       end
@@ -46,12 +47,33 @@ module OmniAI
         }
       end
 
+      # @param other [OmniAI::Chat::Payload]
+      def merge!(other)
+        return unless other
+
+        @usage = other.usage if other.usage
+
+        other.choices.each do |choice|
+          if choice?(index: choice.index)
+            choices[choice.index] = choices[choice.index].merge(choice)
+          else
+            @choices[choice.index] = choice
+          end
+        end
+      end
+
       # @param index [Integer]
       # @return [Choice]
       def choice(index: 0)
         @choices[index]
       end
 
+      # @param index [Integer]
+      # @return [Boolean]
+      def choice?(index: 0)
+        !choice(index:).nil?
+      end
+
       # @param index [Integer]
       # @return [Message]
       def message(index: 0)

data/lib/omniai/chat/stream.rb

@@ -2,23 +2,35 @@
 
 module OmniAI
   class Chat
-    # Used when streaming to process chunks of data.
+    # A stream is used to process a series of chunks of data. It converts the following into a combined payload:
+    #
+    #   { "id":"...", "choices": [{ "index": 0,"delta": { "role" :"assistant", "content":"" } }] }
+    #   { "id":"...", "choices": [{ "index": 0,"delta": { "content" :"A" } }] }
+    #   { "id":"...", "choices": [{ "index": 0,"delta": { "content" :"B" } }] }
+    #   ...
+    #
+    # Every
     class Stream
       # @param logger [OmniAI::Client]
-      # @param body [HTTP::Response::Body]
+      # @param chunks [Enumerable<String>]
       # @param context [Context, nil]
-      def initialize(body:, logger: nil, context: nil)
-        @body = body
+      def initialize(chunks:, logger: nil, context: nil)
+        @chunks = chunks
         @logger = logger
         @context = context
       end
 
       # @yield [payload]
       # @yieldparam payload [OmniAI::Chat::Payload]
+      #
+      # @return [OmniAI::Chat::Payload]
       def stream!(&block)
-        @body.each do |chunk|
-          parser.feed(chunk) do |type, data, id|
-            process!(type, data, id, &block)
+        OmniAI::Chat::Payload.new.tap do |payload|
+          @chunks.map do |chunk|
+            parser.feed(chunk) do |type, data, id|
+              result = process!(type, data, id, &block)
+              payload.merge!(result) if result.is_a?(OmniAI::Chat::Payload)
+            end
           end
         end
       end
@@ -42,14 +54,15 @@ module OmniAI
       # @param data [String]
       # @param id [String]
       #
-      # @yield [payload]
-      # @yieldparam payload [OmniAI::Chat::Payload]
+      # @return [OmniAI::Chat::Payload, nil]
       def process!(type, data, id, &block)
         log(type, data, id)
 
         return if data.eql?("[DONE]")
 
-        block.call(Payload.deserialize(JSON.parse(data), context: @context))
+        payload = Payload.deserialize(JSON.parse(data), context: @context)
+        block&.call(payload)
+        payload
       end
 
       # @return [EventStreamParser::Parser]

data/lib/omniai/chat.rb

@@ -162,11 +162,12 @@ module OmniAI
     end
 
     # @param response [HTTP::Response]
-    # @return [OmniAI::Chat::Stream]
+    #
+    # @return [OmniAI::Chat::Payload]
     def stream!(response:)
       raise Error, "#{self.class.name}#stream! unstreamable" unless @stream
 
-      self.class::Stream.new(body: response.body, logger:, context:).stream! do |chunk|
+      payload = self.class::Stream.new(chunks: response.body, logger:, context:).stream! do |chunk|
         case @stream
         when IO, StringIO
           if chunk.text
@@ -178,6 +179,8 @@ module OmniAI
       end
 
       @stream.puts if @stream.is_a?(IO) || @stream.is_a?(StringIO)
+
+      payload
     end
 
     # @return [HTTP::Response]

data/lib/omniai/cli.rb

@@ -10,8 +10,6 @@ module OmniAI
   #   cli = OmniAI::CLI.new
   #   cli.parse
   class CLI
-    ChatArgs = Struct.new(:provider, :model, :temperature)
-
     # @param stdin [IO] a stream
     # @param stdout [IO] a stream
     # @param provider [String] a provider

data/lib/omniai/tool/property.rb

@@ -58,7 +58,7 @@ module OmniAI
       #   )
       #
       # @param properties [Hash<String, OmniAI::Tool::Property>] required - the properties of the object
-      # @param requird [Array<Symbol>] optional - the required properties
+      # @param required [Array<Symbol>] optional - the required properties
       # @param description [String] optional - a description of the object
       #
       # @return [OmniAI::Tool::Array]

data/lib/omniai/transcribe/transcription.rb

@@ -4,7 +4,17 @@ module OmniAI
   class Transcribe
     # A transcription returned by the API.
     class Transcription
-      attr_accessor :text, :model, :format
+      # @!attribute [rw] text
+      #   @return [String]
+      attr_accessor :text
+
+      # @!attribute [rw] model
+      #   @return [String]
+      attr_accessor :model
+
+      # @!attribute [rw] format
+      #   @return [String]
+      attr_accessor :format
 
       # @param text [String]
       # @param model [String]

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = "1.9.5"
+  VERSION = "1.9.6"
 end

data/lib/omniai.rb

@@ -27,6 +27,7 @@ module OmniAI
       @response = response
     end
 
+    # @return [String]
     def inspect
       "#<#{self.class} status=#{@response.status} body=#{@response.body}>"
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 1.9.5
+  version: 1.9.6
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A generalized framework for interacting with many AI services
 test_files: []