omniai 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b888dff5046dce34b72c4e1e37cad2ed2ce0a9a5259b1a998cc85567dc3f202
-  data.tar.gz: 14d100fd069b47cc0cd6a40794a0582639baf07384050d0e47a574a0062e01b9
+  metadata.gz: ab754f5c048f4d0e4c76e75f142f4e3d511e81a4f2a0585dd466e4b325ccdeb2
+  data.tar.gz: 815d97caf42308a0bfaf183383522c5e34ce08ecab30835390d4c22034b32779
 SHA512:
-  metadata.gz: 3a11e8b75566c699dd7f3c5bf2ae97a004bfb4ff0479e671dd7665db09970627666cacca21d72d11016ab4b783256e96799d66ea65f063492531a5a0320c025a
-  data.tar.gz: cc7e0e511676995ce72b092fd9238ba507f78bb371bc2eb6c1cff0d76ac27c3c28672f1ccd66da4360c4ff1294b6732301744bb4db06c97d51ac65580401dd60
+  metadata.gz: 3497bf2f884a273896d42271170a513462f180bf86ca561f9120a3b8d464485b42400828901ada0bfd3c47ff2f374eb57242149a3664b3b6208b42fcf4227425
+  data.tar.gz: d714671acf5e5c8dcfd3834bfbc529d2fede0967e8e7a3ddda4710588375eb65366c1067e1bcd00220764a6e9d30f583e7478e6e85881762fe005e43f8da3851

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 gem "factory_bot"
 gem "irb"
 gem "rake"
+gem "redcarpet"
 gem "rspec"
 gem "rspec_junit_formatter"
 gem "rubocop"

data/README.md

@@ -119,7 +119,46 @@ end
 The weather is 24° Celsius in London and 42° Fahrenheit in Madrid.
 ```
 
-### Example #5: [Chat w/ CLI](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_cli)
+### Example #5: [Chat w/ History](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_history)
+
+Building a conversation history (e.g. multiple user and assistant messages) is especially helpful when building an agent like conversation experience. A prompt can be used to track this back and forth conversation:
+
+```ruby
+require "omniai/openai"
+
+puts("Type 'exit' or 'quit' to leave.")
+
+client = OmniAI::OpenAI::Client.new
+
+conversation = OmniAI::Chat::Prompt.build do |prompt|
+  prompt.system "You are a helpful assistant. Respond in both English and French."
+end
+
+loop do
+  print "> "
+  text = gets.chomp.strip
+  next if text.empty?
+  break if text.eql?("exit") || text.eql?("quit")
+
+  conversation.user(text)
+  response = client.chat(conversation, stream: $stdout)
+  conversation.assistant(response.text)
+end
+```
+
+```
+Type 'exit' or 'quit' to leave.
+
+> What is the capital of France?
+The capital of France is Paris.
+La capitale de la France est Paris.
+
+> How many people live there?
+The population of Paris is approximately 2.1 million.
+La population de Paris est d’environ 2,1 million.
+```
+
+### Example #6: [Chat w/ CLI](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_cli)
 
 The `OmniAI` gem also ships with a CLI to simplify quick tests.
 
@@ -139,7 +178,7 @@ omniai chat --provider="google" --model="gemini-2.0-flash" "Who are you?"
 I am a large language model, trained by Google.
 ```
 
-### Example #6: [Text-to-Speech](https://github.com/ksylvest/omniai/blob/main/examples/text_to_speech)
+### Example #7: [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.
 
@@ -155,7 +194,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'wb') do |file|
 end
 ```
 
-### Example #7: [Speech-to-Text](https://github.com/ksylvest/omniai/blob/main/examples/speech_to_text)
+### Example #8: [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.
 
@@ -170,7 +209,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'rb') do |file|
 end
 ```
 
-### Example #8: [Embeddings](https://github.com/ksylvest/omniai/blob/main/examples/embeddings)
+### Example #9: [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.
 

data/lib/omniai/chat/response.rb

@@ -75,7 +75,7 @@ module OmniAI
       # @param index [Integer]
       #
       # @return [Boolean]
-      def message?
+      def message?(index: 0)
         !message(index:).nil?
       end
 

data/lib/omniai/cli/base_handler.rb

@@ -2,7 +2,7 @@
 
 module OmniAI
   class CLI
-    # A generic handler for CLI commands (e.g. 'omnia chat').
+    # A generic handler for CLI commands (e.g. 'omniai chat').
     class BaseHandler
       # @param stdin [IO] an optional stream for stdin
       # @param stdout [IO] an optional stream for stdout

data/lib/omniai/cli/chat_handler.rb

@@ -2,7 +2,11 @@
 
 module OmniAI
   class CLI
-    # Used for CLI usage of 'omnia chat'.
+    # Used by CLI to process commands like:
+    #
+    #    omniai chat
+    #    omniai chat "What is the capital of France?"
+    #    omniai chat --provider="google" --model="gemini-2.0-flash" "Who are you?"
     class ChatHandler < BaseHandler
       # @param argv [Array<String>]
       def handle!(argv:)
@@ -20,14 +24,18 @@ module OmniAI
       def listen!
         @stdout.puts('Type "exit" or "quit" to leave.')
 
+        prompt = OmniAI::Chat::Prompt.new
+
         loop do
           @stdout.print("# ")
           @stdout.flush
-          prompt = @stdin.gets&.chomp
+          text = @stdin.gets&.strip
 
-          break if prompt.nil? || prompt.match?(/\A(exit|quit)\z/i)
+          break if text.nil? || text.match?(/\A(exit|quit)\z/i)
 
-          chat(prompt:)
+          prompt.user(text)
+          response = chat(prompt:)
+          prompt.assistant(response.text)
         rescue Interrupt
           break
         end
@@ -48,12 +56,21 @@ module OmniAI
             exit
           end
 
-          options.on("-p", "--provider=PROVIDER", "provider") { |provider| @provider = provider }
-          options.on("-m", "--model=MODEL", "model") { |model| @args[:model] = model }
+          options.on("-p", "--provider=PROVIDER", "provider") do |provider|
+            @provider = provider
+          end
+
+          options.on("-m", "--model=MODEL", "model") do |model|
+            @args[:model] = model
+          end
+
           options.on("-t", "--temperature=TEMPERATURE", Float, "temperature") do |temperature|
             @args[:temperature] = temperature
           end
-          options.on("-f", "--format=FORMAT", "format") { |format| @args[:format] = format.intern }
+
+          options.on("-f", "--format=FORMAT", "format") do |format|
+            @args[:format] = format.intern
+          end
         end
       end
     end

data/lib/omniai/cli/embed_handler.rb

@@ -2,7 +2,9 @@
 
 module OmniAI
   class CLI
-    # Used for CLI usage of 'omnia embed'.
+    # Used by CLI to process commands like:
+    #
+    #    omniai embed "All cats are felidae."
     class EmbedHandler < BaseHandler
       # @param argv [Array<String>]
       def handle!(argv:)

data/lib/omniai/client.rb

@@ -16,71 +16,94 @@ module OmniAI
   #     end
   #   end
   class Client
-    # @return [String, nil]
+    # @!attribute [rw] api_key
+    #   @return [String, nil]
     attr_accessor :api_key
 
-    # @return [Logger, nil]
+    # @!attribute [rw] logger
+    #   @return [Logger, nil]
     attr_accessor :logger
 
-    # @return [String, nil]
+    # @!attribute [rw] host
+    #   @return [String, nil]
     attr_accessor :host
 
-    # @return [Integer, nil]
+    # @!attribute [rw] timeout
+    #  @return [Integer, nil]
     attr_accessor :timeout
 
     # Initialize a client for Anthropic. This method requires the provider if it is undefined.
     #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    #
     # @return [Class<OmniAI::Client>]
     def self.anthropic
       require "omniai/anthropic" unless defined?(OmniAI::Anthropic::Client)
       OmniAI::Anthropic::Client
-    rescue LoadError
+    rescue ::LoadError
       raise Error, "requires 'omniai-anthropic': `gem install omniai-anthropic`"
     end
 
+    # Initialize a client for DeepSeek. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    #
+    # @return [Class<OmniAI::Client>]
+    def self.deepseek
+      require "omniai/deepseek" unless defined?(OmniAI::DeepSeek::Client)
+      OmniAI::DeepSeek::Client
+    rescue ::LoadError
+      raise Error, "requires 'omniai-deepseek': `gem install omniai-deepseek`"
+    end
+
     # Lookup the `OmniAI::Google::Client``. This method requires the provider if it is undefined.
     #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    #
     # @return [Class<OmniAI::Client>]
     def self.google
       require "omniai/google" unless defined?(OmniAI::Google::Client)
       OmniAI::Google::Client
-    rescue LoadError
+    rescue ::LoadError
       raise Error, "requires 'omniai-google': `gem install omniai-google`"
     end
 
     # Initialize a client for Mistral. This method requires the provider if it is undefined.
     #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    #
     # @return [Class<OmniAI::Client>]
     def self.mistral
       require "omniai/mistral" unless defined?(OmniAI::Mistral::Client)
       OmniAI::Mistral::Client
-    rescue LoadError
+    rescue ::LoadError
       raise Error, "requires 'omniai-mistral': `gem install omniai-mistral`"
     end
 
     # Initialize a client for OpenAI. This method requires the provider if it is undefined.
     #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
+    #
     # @return [Class<OmniAI::Client>]
     def self.openai
       require "omniai/openai" unless defined?(OmniAI::OpenAI::Client)
       OmniAI::OpenAI::Client
-    rescue LoadError
+    rescue ::LoadError
       raise Error, "requires 'omniai-openai': `gem install omniai-openai`"
     end
 
     # Initialize a client by provider (e.g. 'openai'). This method attempts to require the provider.
     #
+    # @param provider [String, Symbol] required (e.g. 'anthropic', 'deepsek', 'google', 'mistral', 'openai', etc)
+    #
     # @raise [OmniAI::Error] if the provider is not defined and the gem is not installed
-    # @param provider [String, Symbol] required (e.g. 'anthropic', 'google', 'mistral', 'openai', etc)
+    #
     # @return [OmniAI::Client]
     def self.find(provider:, **)
       klass =
         case provider
         when :anthropic, "anthropic" then anthropic
+        when :deepseek, "deepseek" then deepseek
         when :google, "google" then google
         when :mistral, "mistral" then mistral
         when :openai, "openai" then openai
@@ -169,7 +192,7 @@ module OmniAI
     #
     # @yield [output] optional
     #
-    # @return [Tempfile``]
+    # @return [Tempfile]
     def speak(input, model:, voice:, speed: nil, format: nil, &stream)
       raise NotImplementedError, "#{self.class.name}#speak undefined"
     end

data/lib/omniai/config.rb

@@ -15,28 +15,35 @@ module OmniAI
   #     config.speak_options = { ... }
   #   end
   class Config
-    # @return [String, nil]
+    # @!attribute [rw] api_key
+    #   @return [String, nil]
     attr_accessor :api_key
 
-    # @return [String, nil]
+    # @!attribute [rw] host
+    #   @return [String, nil]
     attr_accessor :host
 
-    # @return [Logger, nil]
+    # @!attribute [rw] logger
+    #   @return [Logger, nil]
     attr_accessor :logger
 
-    # @return [Integer, Hash{Symbol => Integer}, nil]
-    # @option timeout [Integer] :read
-    # @option timeout [Integer] :write
-    # @option timeout [Integer] :connect
+    # @!attribute [rw] timeout
+    #   @return [Integer, Hash{Symbol => Integer}, nil]
+    #   @option timeout [Integer] :read
+    #   @option timeout [Integer] :write
+    #   @option timeout [Integer] :connect
     attr_accessor :timeout
 
-    # @return [Hash]
+    # @!attribute [rw] chat_options
+    #   @return [Hash]
     attr_accessor :chat_options
 
-    # @return [Hash]
+    # @!attribute [rw] transcribe_options
+    #   @return [Hash]
     attr_accessor :transcribe_options
 
-    # @return [Hash]
+    # @!attribute [rw] speak_options
+    #   @return [Hash]
     attr_accessor :speak_options
 
     # @param api_key [String] optional

data/lib/omniai/speak.rb

@@ -5,7 +5,7 @@ module OmniAI
   #
   # Usage:
   #
-  #   class OmniAI::OpenAI::Speak < OmniAI::Speakw
+  #   class OmniAI::OpenAI::Speak < OmniAI::Speak
   #     module Model
   #       WHISPER_1 = "whisper-1"
   #     end

data/lib/omniai/tool.rb

@@ -17,6 +17,8 @@ module OmniAI
   class Tool
     class << self
       # @param description [String]
+      #
+      # @return [String]
       def description(description = nil)
         return @description if description.nil?
 
@@ -61,11 +63,11 @@ module OmniAI
     #   @return [String]
     attr_accessor :name
 
-    # @!attribute [description]
+    # @!attribute [rw] description
     #   @return [String, nil]
     attr_accessor :description
 
-    # @!attribute[parameters]
+    # @!attribute [rw] parameters
     #   @return [Hash, nil]
     attr_accessor :parameters
 

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -19,7 +19,8 @@ module OmniAI
 
   # An error that wraps an HTTP::Response for non-OK requests.
   class HTTPError < Error
-    # @return [HTTP::Response]
+    # @!attribute [rw] response
+    #   @return [HTTP::Response]
     attr_accessor :response
 
     # @param response [HTTP::Response]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser