llm.rb 0.11.0 → 0.12.0

data/lib/llm/providers/xai.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "openai" unless defined?(LLM::OpenAI)
+
+module LLM
+  ##
+  # The XAI class implements a provider for [xAI](https://docs.x.ai).
+  #
+  # @example
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #
+  #   llm = LLM.xai(key: ENV["KEY"])
+  #   bot = LLM::Bot.new(llm)
+  #   bot.chat ["Tell me about this photo", File.open("/images/crow.jpg", "rb")]
+  #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
+  class XAI < OpenAI
+    require_relative "xai/images"
+
+    ##
+    # @param [String] host A regional host or the default ("api.x.ai")
+    # @param key (see LLM::Provider#initialize)
+    # @see https://docs.x.ai/docs/key-information/regions Regional endpoints
+    def initialize(host: "api.x.ai", **)
+      super
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def files
+      raise NotImplementedError
+    end
+
+    ##
+    # @return [LLM::XAI::Images]
+    def images
+      LLM::XAI::Images.new(self)
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def audio
+      raise NotImplementedError
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def moderations
+      raise NotImplementedError
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def responses
+      raise NotImplementedError
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def vector_stores
+      raise NotImplementedError
+    end
+
+    ##
+    # Returns the default model for chat completions
+    # #see https://docs.x.ai/docs/models grok-4-0709
+    # @return [String]
+    def default_model
+      "grok-4-0709"
+    end
+  end
+end

data/lib/llm/response.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module LLM
+  ##
+  # {LLM::Response LLM::Response} encapsulates a response
+  # from an LLM provider. It is returned by all methods
+  # that make requests to a provider, and sometimes extended
+  # with provider-specific functionality.
   class Response
     require "json"
 

data/lib/llm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LLM
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/llm.rb

@@ -17,7 +17,7 @@ module LLM
   require_relative "llm/buffer"
   require_relative "llm/function"
   require_relative "llm/eventstream"
-  require_relative "llm/event_handler"
+  require_relative "llm/eventhandler"
 
   module_function
 
@@ -69,6 +69,15 @@ module LLM
     LLM::OpenAI.new(**)
   end
 
+  ##
+  # @param key (see LLM::XAI#initialize)
+  # @param host (see LLM::XAI#initialize)
+  # @return (see LLM::XAI#initialize)
+  def xai(**)
+    require_relative "llm/providers/xai" unless defined?(LLM::XAI)
+    LLM::XAI.new(**)
+  end
+
   ##
   # Define a function
   # @example

data/llm.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
 
   spec.summary = <<~SUMMARY
   llm.rb is a zero-dependency Ruby toolkit for Large Language Models that
-  includes OpenAI, Gemini, Anthropic, DeepSeek, Ollama, and LlamaCpp. The
-  toolkit includes full support for chat, streaming, tool calling, audio,
-  images, files, and JSON Schema generation.
+  includes OpenAI, Gemini, Anthropic, xAI (grok), DeepSeek, Ollama, and
+  LlamaCpp. The toolkit includes full support for chat, streaming, tool calling,
+  audio, images, files, and JSON Schema generation.
   SUMMARY
 
   spec.description = spec.summary
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "test-cmd.rb", "~> 0.12.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 1.40"
+  spec.add_development_dependency "standard", "~> 1.50"
   spec.add_development_dependency "vcr", "~> 6.0"
   spec.add_development_dependency "dotenv", "~> 2.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Antar Azri
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.40'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -151,9 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 description: llm.rb is a zero-dependency Ruby toolkit for Large Language Models that
-  includes OpenAI, Gemini, Anthropic, DeepSeek, Ollama, and LlamaCpp. The toolkit
-  includes full support for chat, streaming, tool calling, audio, images, files, and
-  JSON Schema generation.
+  includes OpenAI, Gemini, Anthropic, xAI (grok), DeepSeek, Ollama, and LlamaCpp.
+  The toolkit includes full support for chat, streaming, tool calling, audio, images,
+  files, and JSON Schema generation.
 email:
 - azantar@proton.me
 - 0x1eef@proton.me
@@ -171,7 +171,7 @@ files:
 - lib/llm/bot/prompt/respond.rb
 - lib/llm/buffer.rb
 - lib/llm/error.rb
-- lib/llm/event_handler.rb
+- lib/llm/eventhandler.rb
 - lib/llm/eventstream.rb
 - lib/llm/eventstream/event.rb
 - lib/llm/eventstream/parser.rb
@@ -247,6 +247,8 @@ files:
 - lib/llm/providers/openai/responses.rb
 - lib/llm/providers/openai/stream_parser.rb
 - lib/llm/providers/openai/vector_stores.rb
+- lib/llm/providers/xai.rb
+- lib/llm/providers/xai/images.rb
 - lib/llm/response.rb
 - lib/llm/utils.rb
 - lib/llm/version.rb
@@ -274,7 +276,7 @@ requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
 summary: llm.rb is a zero-dependency Ruby toolkit for Large Language Models that includes
-  OpenAI, Gemini, Anthropic, DeepSeek, Ollama, and LlamaCpp. The toolkit includes
-  full support for chat, streaming, tool calling, audio, images, files, and JSON Schema
-  generation.
+  OpenAI, Gemini, Anthropic, xAI (grok), DeepSeek, Ollama, and LlamaCpp. The toolkit
+  includes full support for chat, streaming, tool calling, audio, images, files, and
+  JSON Schema generation.
 test_files: []