omniai 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9cab46e52805a61d08bf4638ef7ed9ab46549c016ada8740abb7471f3ee5d07
-  data.tar.gz: 3a34ea68b515d8759a76d689f2474648c7e55d51b42a93ee022c18df271e049e
+  metadata.gz: a80f4da0021307bce467f92f209309aaea62060e93fbb4201a7fc059b0376cea
+  data.tar.gz: 329e4a51e2e8b1d66ed5eca4bf7979acc1111f720d62fdfb638d850ca9ff53d8
 SHA512:
-  metadata.gz: b241dca1c95f27efd023c09cb6ed9e8193f94e2487490b376a816e5c50d8a6a42e6cb0bc54e47ec3aeba0b12f23de7b3a258d9ca29d222ce6bf414469e2ad777
-  data.tar.gz: b74ba2a9950c821b7ca6bd5d1348165daab7dea3b7372db702d40cdda8d2669c057b32913cf5713b6d75cf3d97a234acf25c1f11af3357cc465740b18ec5990e
+  metadata.gz: 5ce5f9abf61e35856183ebfdf344f41d2961f67140abdd19b48464203a10358e368b606ec8d775e32a515e202c87b69c205a3dc688743ddb072ef70962753948
+  data.tar.gz: f517cf093a2304dd4d6562bdf8a96c78480523063e9ff21463b08b2214064efdd65782af50ef070c836502e54dccce37d66f3636027c41409a62dff1abd2eb83

data/README.md

@@ -10,13 +10,14 @@ OmniAI provides a unified Ruby API for integrating with multiple AI providers, i
 
 - [OmniAI::Anthropic](https://github.com/ksylvest/omniai-anthropic)
 - [OmniAI::DeepSeek](https://github.com/ksylvest/omniai-deepseek)
+- [OmniAI::Llama](https://github.com/ksylvest/omniai-llama)
 - [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 - [OmniAI::Mistral](https://github.com/ksylvest/omniai-mistral)
 - [OmniAI::OpenAI](https://github.com/ksylvest/omniai-openai)
 
-## Examples
+## 📄 Examples
 
-### Example #1: [Chat w/ Text](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_text)
+### Example #1: [💬 Chat w/ Text](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_text)
 
 This example demonstrates using `OmniAI` with **Anthropic** to ask for a joke. The response is parsed and printed.
 
@@ -32,7 +33,7 @@ puts client.chat("Tell me a joke").text
 Why don't scientists trust atoms? Because they make up everything!
 ```
 
-### Example #2: [Chat w/ Prompt](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_prompt)
+### Example #2: [💬 Chat w/ Prompt](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_prompt)
 
 This example demonstrates using `OmniAI` with **Mistral** to ask for the fastest animal. It includes a system and user message in the prompt. The response is streamed in real time.
 
@@ -52,7 +53,7 @@ end
 **French**: Le faucon pèlerin est généralement considéré comme l'animal le plus rapide, atteignant des vitesses de plus de 390 km/h.
 ```
 
-### Example #3: [Chat w/ Vision](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_vision)
+### Example #3: [💬 Chat w/ Vision](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_vision)
 
 This example demonstrates using `OmniAI` with **OpenAI** 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.
 
@@ -79,7 +80,7 @@ The first photo is of a cat, *Felis Catus*.
 The second photo is of a dog, *Canis Familiaris*.
 ```
 
-### Example #4: [Chat w/ Tools](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_tools)
+### Example #4: [💬 Chat w/ Tools](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_tools)
 
 This example demonstrates using `OmniAI` with **Google** to ask for the weather. A tool “Weather” is provided. The tool accepts a location and unit (Celsius or Fahrenheit) then calculates the weather. The LLM makes multiple tool-call requests and is automatically provided with a tool-call response prior to streaming in real-time the result.
 
@@ -149,7 +150,7 @@ The weather is 24° Celsius in London and 42° Fahrenheit in Madrid.
 
 _For a set of pre-built tools for interacting with browsers, databases, docker, and more try the [OmniAI::Tools](https://omniai-tools.ksylvest.com/) project._
 
-### Example #5: [Chat w/ History](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_history)
+### Example #5: [💬 Chat w/ History](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_history)
 
 Tracking a prompt history over 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:
 
@@ -176,7 +177,7 @@ loop do
 end
 ```
 
-### Example #6 [Chat w/ Schema](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_schema)
+### Example #6 [💬 Chat w/ Schema](https://github.com/ksylvest/omniai/blob/main/examples/chat_with_schema)
 
 Requesting structured data back from an LLM is possible by defining a schema, then passing the schema into the chat. The following example defines a structured schema using `OmniAI::Schema` to model a `Contact`. The results of the LLM call are then parsed using the schema to ensure all types are correct.
 
@@ -228,7 +229,7 @@ puts format.parse(response.text)
 }
 ```
 
-### Example #7: [CLI](https://github.com/ksylvest/omniai/blob/main/examples/cli)
+### Example #7: [🐚 CLI](https://github.com/ksylvest/omniai/blob/main/examples/cli)
 
 The `OmniAI` gem also ships with a CLI to simplify quick tests.
 
@@ -251,7 +252,7 @@ omniai transcribe "./files/audio.wav"
 omniai embed "What is the capital of France?"
 ```
 
-### Example #8: [Text-to-Speech](https://github.com/ksylvest/omniai/blob/main/examples/text_to_speech)
+### Example #8: [🔈 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.
 
@@ -267,7 +268,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'wb') do |file|
 end
 ```
 
-### Example #9: [Speech-to-Text](https://github.com/ksylvest/omniai/blob/main/examples/speech_to_text)
+### Example #9: [🎤 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.
 
@@ -282,7 +283,7 @@ File.open(File.join(__dir__, 'audio.wav'), 'rb') do |file|
 end
 ```
 
-### Example #10: [Embeddings](https://github.com/ksylvest/omniai/blob/main/examples/embeddings)
+### Example #10: [💻 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.
 
@@ -325,7 +326,7 @@ search('Who do you call to fix a toilet?')
 'Who do you call to fix a toilet?': 'Paul is a plumber.'
 ```
 
-## Installation
+## 📦 Installation
 
 The main `omniai` gem is installed with:
 
@@ -343,7 +344,7 @@ gem install omniai-google
 gem install omniai-openai
 ```
 
-## Usage
+## 📖 Usage
 
 OmniAI implements APIs for a number of popular clients by default. A client can be initialized using the specific gem (e.g. `omniai-openai` for `OmniAI::OpenAI`). Vendor specific docs can be found within each repo.
 
@@ -365,6 +366,14 @@ require 'omniai/deepseek'
 client = OmniAI::DeepSeek::Client.new
 ```
 
+#### [OmniAI::Llama](https://github.com/ksylvest/omniai-llama)
+
+```ruby
+require 'omniai/llama'
+
+client = OmniAI::Llama::Client.new
+```
+
 #### [OmniAI::Google](https://github.com/ksylvest/omniai-google)
 
 ```ruby
@@ -445,7 +454,7 @@ client = OmniAI::OpenAI::Client.new(timeout: {
 })
 ```
 
-### Chat
+### 💬 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:
 
@@ -523,7 +532,7 @@ end
 client.chat('What is the weather in "London" in Celsius and "Paris" in Fahrenheit?', tools: [WeatherTool.new])
 ```
 
-### Transcribe
+### 🎤 Speech to Text
 
 Clients that support transcribe (e.g. OpenAI w/ "Whisper") convert recordings to text via the following calls:
 
@@ -543,7 +552,7 @@ File.open("example.ogg", "rb") do |file|
 end
 ```
 
-### Speak
+### 🔈 Text to Speech
 
 Clients that support speak (e.g. OpenAI w/ "Whisper") convert text to speech via the following calls:
 
@@ -565,7 +574,7 @@ tempfile.close
 tempfile.unlink
 ```
 
-### Embeddings
+### 💻 Embeddings
 
 Clients that support generating embeddings (e.g. OpenAI, Mistral, etc.) convert text to embeddings via the following:
 
@@ -588,7 +597,7 @@ response.embeddings.each do |embedding|
 end
 ```
 
-## CLI
+## 🐚 CLI
 
 OmniAI packages a basic command line interface (CLI) to allow for exploration of various APIs. CLI documentation is available with the `--help` flag:
 
@@ -665,7 +674,7 @@ omniai speak "Sally sells sea shells on the sea shore." > audio.aac
 omniai transcribe ./audio.aac
 ```
 
-### MCP
+## MCP
 
 [MCP](https://modelcontextprotocol.io/introduction) is an open protocol designed to standardize giving context to LLMs. The OmniAI implementation supports building an MCP server that operates via the [stdio](https://modelcontextprotocol.io/docs/concepts/transports) transport.
 

data/lib/omniai/client.rb

@@ -56,6 +56,18 @@ module OmniAI
       raise LoadError, "requires 'omniai-deepseek': `gem install omniai-deepseek`"
     end
 
+    # Lookup the `OmniAI::LLama::Client``. This method requires the provider if it is undefined.
+    #
+    # @raise [OmniAI::LoadError] if the provider is not defined and the gem is not installed
+    #
+    # @return [Class<OmniAI::Client>]
+    def self.llama
+      require "omniai/llama" unless defined?(OmniAI::Llama::Client)
+      OmniAI::Llama::Client
+    rescue ::LoadError
+      raise LoadError, "requires 'omniai-llama': `gem install omniai-llama`"
+    end
+
     # Lookup the `OmniAI::Google::Client``. This method requires the provider if it is undefined.
     #
     # @raise [OmniAI::LoadError] if the provider is not defined and the gem is not installed
@@ -105,11 +117,12 @@ module OmniAI
       end
 
       raise LoadError, <<~TEXT
-        requires 'omniai-openai' or 'omniai-anthropic' or 'openai-deepseek' or 'omniai-google' or 'omniai-mistral':
+        Please run one of the following commands to install a provider specific gem:
 
           `gem install omniai-openai`
           `gem install omniai-anthropic`
           `gem install omniai-deepseek`
+          `gem install omniai-llama`
           `gem install omniai-google`
           `gem install omniai-mistral`
       TEXT
@@ -118,7 +131,7 @@ module OmniAI
     # Initialize a client by provider (e.g. 'openai'). This method attempts to require the provider.
     #
     #
-    # @param provider [String, Symbol] required (e.g. 'anthropic', 'deepseek', 'google', 'mistral', 'openai', etc)
+    # @param provider [String, Symbol] required (e.g. 'anthropic', 'deepseek', 'google', 'mistral', 'openai', 'llama')
     #
     # @raise [OmniAI::LoadError] if the provider is not defined and the gem is not installed
     #
@@ -129,6 +142,7 @@ module OmniAI
         when :anthropic, "anthropic" then anthropic
         when :deepseek, "deepseek" then deepseek
         when :google, "google" then google
+        when :llama, "llama" then llama
         when :mistral, "mistral" then mistral
         when :openai, "openai" then openai
         else raise Error, "unknown provider=#{provider.inspect}"

data/lib/omniai/schema/object.rb

@@ -64,6 +64,16 @@ module OmniAI
         @required = required
       end
 
+      # @return [OmniAI::Schema::Object]
+      def dup
+        self.class.new(
+          title: @title,
+          description: @description,
+          properties: @properties.dup,
+          required: @required.dup
+        )
+      end
+
       # @return [Hash]
       def serialize
         {

data/lib/omniai/tool.rb

@@ -16,18 +16,20 @@ module OmniAI
   #   end
   class Tool
     class << self
-      # @param description [String]
+      # @param description [String] optional
       #
       # @return [String]
       def description(description = nil)
-        return @description if description.nil?
-
-        @description = description
+        if description.nil?
+          @description || (superclass.description unless superclass.eql?(OmniAI::Tool))
+        else
+          @description = description
+        end
       end
 
       # @return [OmniAI::Schema::Object]
       def parameters
-        @parameters ||= OmniAI::Schema::Object.new
+        @parameters ||= superclass.eql?(OmniAI::Tool) ? superclass.parameters.dup : OmniAI::Schema::Object.new
       end
 
       # @param name [Symbol]
@@ -38,7 +40,7 @@ module OmniAI
 
       # @param names [Array<Symbol>]
       def required(names)
-        parameters.required = names
+        parameters.required += names
       end
 
       # Converts a class name to a tool:

data/lib/omniai/version.rb

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

data/lib/omniai.rb

@@ -25,9 +25,9 @@ loader.setup
 module OmniAI
   class Error < StandardError; end
 
-  # Discover a client by provider ('openai' then 'anthropic' then 'google' then 'mistral' then 'deepseek').
+  # Discover a client by provider ('openai' then 'anthropic' then 'google' then 'mistral' then 'deepseek' then 'llama').
   #
-  # @param provider [Symbol] the provider to use (e.g. :openai, :anthropic, :google, :mistral, :deepseek) - optional
+  # @param provider [Symbol] the provider to use (e.g. :openai, :anthropic, :google, :mistral, :deepseek, :llama)
   #
   # @raise [OmniAI::LoadError] if no providers are installed
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-05-22 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser