llm.rb 0.11.0 → 0.12.0

data/lib/llm/providers/gemini.rb

@@ -3,30 +3,19 @@
 module LLM
   ##
   # The Gemini class implements a provider for
-  # [Gemini](https://ai.google.dev/).
+  # [Gemini](https://ai.google.dev/). The Gemini provider
+  # can accept multiple inputs (text, images, audio, and video).
+  # The inputs can be provided inline via the prompt for files
+  # under 20MB or via the Gemini Files API for files
+  # that are over 20MB.
   #
-  # The Gemini provider can accept multiple inputs (text, images,
-  # audio, and video). The inputs can be provided inline via the
-  # prompt for files under 20MB or via the Gemini Files API for
-  # files that are over 20MB
-  #
-  # @example example #1
-  #   #!/usr/bin/env ruby
-  #   require "llm"
-  #
-  #   llm = LLM.gemini(ENV["KEY"])
-  #   bot = LLM::Bot.new(llm)
-  #   bot.chat LLM.File("/images/capybara.png")
-  #   bot.chat "Describe the image"
-  #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
-  #
-  # @example example #2
+  # @example
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.gemini(ENV["KEY"])
+  #   llm = LLM.gemini(key: ENV["KEY"])
   #   bot = LLM::Bot.new(llm)
-  #   bot.chat ["Describe the image", LLM::File("/images/capybara.png")]
+  #   bot.chat ["Tell me about this photo", File.open("/images/horse.jpg", "rb")]
   #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class Gemini < Provider
     require_relative "gemini/response/embedding"
@@ -55,7 +44,7 @@ module LLM
     # @param model (see LLM::Provider#embed)
     # @param params (see LLM::Provider#embed)
     # @raise (see LLM::Provider#request)
-    # @return (see LLM::Provider#embed)
+    # @return [LLM::Response]
     def embed(input, model: "text-embedding-004", **params)
       model = model.respond_to?(:id) ? model.id : model
       path = ["/v1beta/models/#{model}", "embedContent?key=#{@key}"].join(":")
@@ -74,7 +63,7 @@ module LLM
     # @raise (see LLM::Provider#request)
     # @raise [LLM::PromptError]
     #  When given an object a provider does not understand
-    # @return (see LLM::Provider#complete)
+    # @return [LLM::Response]
     def complete(prompt, params = {})
       params = {role: :user, model: default_model}.merge!(params)
       params = [params, format_schema(params), format_tools(params)].inject({}, &:merge!).compact
@@ -93,6 +82,7 @@ module LLM
     ##
     # Provides an interface to Gemini's audio API
     # @see https://ai.google.dev/gemini-api/docs/audio Gemini docs
+    # @return [LLM::Gemini::Audio]
     def audio
       LLM::Gemini::Audio.new(self)
     end
@@ -108,6 +98,7 @@ module LLM
     ##
     # Provides an interface to Gemini's file management API
     # @see https://ai.google.dev/gemini-api/docs/files Gemini docs
+    # @return [LLM::Gemini::Files]
     def files
       LLM::Gemini::Files.new(self)
     end
@@ -115,6 +106,7 @@ module LLM
     ##
     # Provides an interface to Gemini's models API
     # @see https://ai.google.dev/gemini-api/docs/models Gemini docs
+    # @return [LLM::Gemini::Models]
     def models
       LLM::Gemini::Models.new(self)
     end

data/lib/llm/providers/llamacpp.rb

@@ -7,7 +7,18 @@ module LLM
   # The LlamaCpp class implements a provider for
   # [llama.cpp](https://github.com/ggml-org/llama.cpp)
   # through the OpenAI-compatible API provided by the
-  # llama-server binary.
+  # llama-server binary. Similar to the ollama provider,
+  # this provider supports a wide range of models and
+  # is straightforward to run on your own hardware.
+  #
+  # @example
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #
+  #   llm = LLM.llamacpp(key: nil)
+  #   bot = LLM::Bot.new(llm)
+  #   bot.chat ["Tell me about this photo", File.open("/images/frog.jpg", "rb")]
+  #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class LlamaCpp < OpenAI
     ##
     # @param (see LLM::Provider#initialize)

data/lib/llm/providers/ollama/response/embedding.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 module LLM::Ollama::Response
@@ -7,4 +6,4 @@ module LLM::Ollama::Response
     def prompt_tokens = body.dig("usage", "prompt_tokens") || 0
     def total_tokens = body.dig("usage", "total_tokens") || 0
   end
-end
+end

data/lib/llm/providers/ollama.rb

@@ -2,21 +2,18 @@
 
 module LLM
   ##
-  # The Ollama class implements a provider for [Ollama](https://ollama.ai/).
-  #
-  # This provider supports a wide range of models, it is relatively
-  # straight forward to run on your own hardware, and includes multi-modal
-  # models that can process images and text. See the example for a demonstration
-  # of a multi-modal model by the name `llava`
+  # The Ollama class implements a provider for [Ollama](https://ollama.ai/) –
+  # and the provider supports a wide range of models. It is straight forward
+  # to run on your own hardware, and there are a number of multi-modal models
+  # that can process both images and text.
   #
   # @example
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.ollama(nil)
+  #   llm = LLM.ollama(key: nil)
   #   bot = LLM::Bot.new(llm, model: "llava")
-  #   bot.chat LLM::File("/images/capybara.png")
-  #   bot.chat "Describe the image"
+  #   bot.chat ["Tell me about this image", File.open("/images/parrot.png", "rb")]
   #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class Ollama < Provider
     require_relative "ollama/response/embedding"
@@ -42,7 +39,7 @@ module LLM
     # @param model (see LLM::Provider#embed)
     # @param params (see LLM::Provider#embed)
     # @raise (see LLM::Provider#request)
-    # @return (see LLM::Provider#embed)
+    # @return [LLM::Response]
     def embed(input, model: default_model, **params)
       params   = {model:}.merge!(params)
       req      = Net::HTTP::Post.new("/v1/embeddings", headers)
@@ -60,7 +57,7 @@ module LLM
     # @raise (see LLM::Provider#request)
     # @raise [LLM::PromptError]
     #  When given an object a provider does not understand
-    # @return (see LLM::Provider#complete)
+    # @return [LLM::Response]
     def complete(prompt, params = {})
       params = {role: :user, model: default_model, stream: true}.merge!(params)
       params = [params, {format: params[:schema]}, format_tools(params)].inject({}, &:merge!).compact

data/lib/llm/providers/openai/audio.rb

@@ -5,7 +5,7 @@ class LLM::OpenAI
   # The {LLM::OpenAI::Audio LLM::OpenAI::Audio} class provides an audio
   # object for interacting with [OpenAI's audio API](https://platform.openai.com/docs/api-reference/audio/createSpeech).
   # @example
-  #   llm = LLM.openai(ENV["KEY"])
+  #   llm = LLM.openai(key: ENV["KEY"])
   #   res = llm.audio.create_speech(input: "A dog on a rocket to the moon")
   #   IO.copy_stream res.audio, "rocket.mp3"
   class Audio
@@ -20,7 +20,7 @@ class LLM::OpenAI
     ##
     # Create an audio track
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.images.create_speech(input: "A dog on a rocket to the moon")
     #   File.binwrite("rocket.mp3", res.audio.string)
     # @see https://platform.openai.com/docs/api-reference/audio/createSpeech OpenAI docs
@@ -42,7 +42,7 @@ class LLM::OpenAI
     ##
     # Create an audio transcription
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.audio.create_transcription(file: "/audio/rocket.mp3")
     #   res.text # => "A dog on a rocket to the moon"
     # @see https://platform.openai.com/docs/api-reference/audio/createTranscription OpenAI docs
@@ -64,7 +64,7 @@ class LLM::OpenAI
     # Create an audio translation (in English)
     # @example
     #   # Arabic => English
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.audio.create_translation(file: "/audio/bismillah.mp3")
     #   res.text # => "In the name of Allah, the Beneficent, the Merciful."
     # @see https://platform.openai.com/docs/api-reference/audio/createTranslation OpenAI docs

data/lib/llm/providers/openai/files.rb

@@ -12,21 +12,10 @@ class LLM::OpenAI
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.openai(ENV["KEY"])
+  #   llm = LLM.openai(key: ENV["KEY"])
   #   bot = LLM::Bot.new(llm)
-  #   file = llm.files.create file: "/documents/freebsd.pdf"
-  #   bot.chat(file)
-  #   bot.chat("Describe the document")
-  #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
-  #
-  # @example example #2
-  #   #!/usr/bin/env ruby
-  #   require "llm"
-  #
-  #   llm = LLM.openai(ENV["KEY"])
-  #   bot = LLM::Bot.new(llm)
-  #   file = llm.files.create file: "/documents/openbsd.pdf"
-  #   bot.chat(["Describe the document I sent to you", file])
+  #   file = llm.files.create file: "/books/goodread.pdf"
+  #   bot.chat ["Tell me about this PDF", file]
   #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class Files
     require_relative "response/file"
@@ -42,7 +31,7 @@ class LLM::OpenAI
     ##
     # List all files
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.files.all
     #   res.each do |file|
     #     print "id: ", file.id, "\n"
@@ -61,7 +50,7 @@ class LLM::OpenAI
     ##
     # Create a file
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.files.create file: "/documents/haiku.txt"
     # @see https://platform.openai.com/docs/api-reference/files/create OpenAI docs
     # @param [File, LLM::File, String] file The file
@@ -81,7 +70,7 @@ class LLM::OpenAI
     ##
     # Get a file
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.files.get(file: "file-1234567890")
     #   print "id: ", res.id, "\n"
     # @see https://platform.openai.com/docs/api-reference/files/get OpenAI docs
@@ -100,7 +89,7 @@ class LLM::OpenAI
     ##
     # Download the content of a file
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.files.download(file: "file-1234567890")
     #   File.binwrite "haiku1.txt", res.file.read
     #   print res.file.read, "\n"
@@ -121,7 +110,7 @@ class LLM::OpenAI
     ##
     # Delete a file
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.files.delete(file: "file-1234567890")
     #   print res.deleted, "\n"
     # @see https://platform.openai.com/docs/api-reference/files/delete OpenAI docs

data/lib/llm/providers/openai/images.rb

@@ -2,27 +2,27 @@
 
 class LLM::OpenAI
   ##
-  # The {LLM::OpenAI::Images LLM::OpenAI::Images} class provides an images
-  # object for interacting with [OpenAI's images API](https://platform.openai.com/docs/api-reference/images).
+  # The {LLM::OpenAI::Images LLM::OpenAI::Images} class provides an interface
+  # for [OpenAI's images API](https://platform.openai.com/docs/api-reference/images).
   # OpenAI supports multiple response formats: temporary URLs, or binary strings
   # encoded in base64. The default is to return temporary URLs.
   #
-  # @example example #1
+  # @example Temporary URLs
   #   #!/usr/bin/env ruby
   #   require "llm"
   #   require "open-uri"
   #   require "fileutils"
   #
-  #   llm = LLM.openai(ENV["KEY"])
+  #   llm = LLM.openai(key: ENV["KEY"])
   #   res = llm.images.create prompt: "A dog on a rocket to the moon"
   #   FileUtils.mv OpenURI.open_uri(res.urls[0]).path,
   #                "rocket.png"
   #
-  # @example example #2
+  # @example Binary strings
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.openai(ENV["KEY"])
+  #   llm = LLM.openai(key: ENV["KEY"])
   #   res = llm.images.create prompt: "A dog on a rocket to the moon",
   #                           response_format: "b64_json"
   #   IO.copy_stream res.images[0], "rocket.png"
@@ -39,9 +39,9 @@ class LLM::OpenAI
     ##
     # Create an image
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.images.create prompt: "A dog on a rocket to the moon"
-    #   p res.urls
+    #   res.urls.each { print _1, "\n" }
     # @see https://platform.openai.com/docs/api-reference/images/create OpenAI docs
     # @param [String] prompt The prompt
     # @param [String] model The model to use
@@ -58,7 +58,7 @@ class LLM::OpenAI
     ##
     # Create image variations
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.images.create_variation(image: "/images/hat.png", n: 5)
     #   p res.urls
     # @see https://platform.openai.com/docs/api-reference/images/createVariation OpenAI docs
@@ -80,7 +80,7 @@ class LLM::OpenAI
     ##
     # Edit an image
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.images.edit(image: "/images/hat.png", prompt: "A cat wearing this hat")
     #   p res.urls
     # @see https://platform.openai.com/docs/api-reference/images/createEdit OpenAI docs

data/lib/llm/providers/openai/models.rb

@@ -11,7 +11,7 @@ class LLM::OpenAI
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.openai(ENV["KEY"])
+  #   llm = LLM.openai(key: ENV["KEY"])
   #   res = llm.models.all
   #   res.each do |model|
   #     print "id: ", model.id, "\n"
@@ -28,7 +28,7 @@ class LLM::OpenAI
     ##
     # List all models
     # @example
-    #   llm = LLM.openai(ENV["KEY"])
+    #   llm = LLM.openai(key: ENV["KEY"])
     #   res = llm.models.all
     #   res.each do |model|
     #     print "id: ", model.id, "\n"

data/lib/llm/providers/openai/response/completion.rb

@@ -16,7 +16,7 @@ module LLM::OpenAI::Response
       end
     end
     alias_method :messages, :choices
-    
+
     def model = body.model
     def prompt_tokens = body.usage&.prompt_tokens
     def completion_tokens = body.usage&.completion_tokens
@@ -36,4 +36,4 @@ module LLM::OpenAI::Response
       end
     end
   end
-end
+end

data/lib/llm/providers/openai/response/embedding.rb

@@ -1,9 +1,9 @@
- # frozen_string_literal: true
+# frozen_string_literal: true
 
- module LLM::OpenAI::Response
+module LLM::OpenAI::Response
   module Embedding
     def embeddings = data.map { _1["embedding"] }
     def prompt_tokens = data.dig(0, "usage", "prompt_tokens")
     def total_tokens = data.dig(0, "usage", "total_tokens")
   end
-end
+end

data/lib/llm/providers/openai/response/responds.rb

@@ -2,7 +2,6 @@
 
 module LLM::OpenAI::Response
   module Responds
-
     def outputs = [format_message]
     def choices = body.output
     def tools = output.select { _1.type == "function_call" }

data/lib/llm/providers/openai/responses.rb

@@ -2,36 +2,17 @@
 
 class LLM::OpenAI
   ##
-  # The {LLM::OpenAI::Responses LLM::OpenAI::Responses} class provides a responses
-  # object for interacting with [OpenAI's response API](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses).
-  # The responses API is similar to the chat completions API but it can maintain
-  # conversation state across multiple requests. This is useful when you want to
-  # save bandwidth and/or not maintain the message thread by yourself.
+  # The {LLM::OpenAI::Responses LLM::OpenAI::Responses} class provides
+  # an interface for [OpenAI's response API](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses).
   #
   # @example example #1
   #   #!/usr/bin/env ruby
   #   require "llm"
   #
-  #   llm = LLM.openai(ENV["KEY"])
-  #   res1 = llm.responses.create "Your task is to help me with math", role: :developer
-  #   res2 = llm.responses.create "5 + 5  = ?", role: :user, previous_response_id: res1.id
-  #   [res1,res2].each { llm.responses.delete(_1) }
-  #
-  # @example example #2
-  #   #!/usr/bin/env ruby
-  #   require "llm"
-  #
-  #   llm  = LLM.openai(ENV["KEY"])
-  #   file = llm.files.create file: "/images/hat.png"
-  #   res  = llm.responses.create ["Describe the image", file]
-  #
-  # @example example #3
-  #   #!/usr/bin/env ruby
-  #   require "llm"
-  #
-  #   llm  = LLM.openai(ENV["KEY"])
-  #   file = llm.files.create file: "/documents/freebsd.pdf"
-  #   res  = llm.responses.create ["Describe the document, file]
+  #   llm = LLM.openai(key: ENV["KEY"])
+  #   res1 = llm.responses.create "Your task is to answer the user's questions", role: :developer
+  #   res2 = llm.responses.create "5 + 5 = X ?", role: :user, previous_response_id: res1.id
+  #   [res1, res2].each { llm.responses.delete(_1) }
   class Responses
     require_relative "response/responds"
     include Format

data/lib/llm/providers/openai/stream_parser.rb

@@ -52,6 +52,7 @@ class LLM::OpenAI
                 target[key] = value
               end
             else
+              @io << value if @io.respond_to?(:<<)
               target[key] = value
             end
           end

data/lib/llm/providers/openai/vector_stores.rb

@@ -2,9 +2,8 @@
 
 class LLM::OpenAI
   ##
-  # The {LLM::OpenAI::VectorStore LLM::OpenAI::VectorStore} class provides
-  # an interface to OpenAI's vector stores API
-  # @see https://platform.openai.com/docs/api-reference/vector_stores/create OpenAI docs
+  # The {LLM::OpenAI::VectorStores LLM::OpenAI::VectorStores} class provides
+  # an interface for [OpenAI's vector stores API](https://platform.openai.com/docs/api-reference/vector_stores/create)
   class VectorStores
     ##
     # @param [LLM::Provider] provider
@@ -97,6 +96,89 @@ class LLM::OpenAI
       LLM::Response.new(res)
     end
 
+    ##
+    # List all files in a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores_files/listFiles OpenAI docs
+    def all_files(vector:, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new("/v1/vector_stores/#{vector_id}/files?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Add a file to a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [String, #id] file The ID of the file to add
+    # @param [Hash] attributes Attributes to associate with the file (optional)
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores_files/createFile OpenAI docs
+    def add_file(vector:, file:, attributes: nil, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Post.new("/v1/vector_stores/#{vector_id}/files", headers)
+      req.body = JSON.dump(params.merge({file_id:, attributes:}).compact)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+    alias_method :create_file, :add_file
+
+    ##
+    # Update a file in a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [String, #id] file The ID of the file to update
+    # @param [Hash] attributes Attributes to associate with the file
+    # @param [Hash] params Other parameters (see OpenAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores_files/updateAttributes OpenAI docs
+    def update_file(vector:, file:, attributes:, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Post.new("/v1/vector_stores/#{vector_id}/files/#{file_id}", headers)
+      req.body = JSON.dump(params.merge({attributes:}).compact)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Get a file from a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [String, #id] file The ID of the file to retrieve
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores_files/getFile OpenAI docs
+    def get_file(vector:, file:, **params)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      file_id = file.respond_to?(:id) ? file.id : file
+      query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new("/v1/vector_stores/#{vector_id}/files/#{file_id}?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Delete a file from a vector store
+    # @param [String, #id] vector The ID of the vector store
+    # @param [String, #id] file The ID of the file to delete
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    # @see https://platform.openai.com/docs/api-reference/vector_stores_files/deleteFile OpenAI docs
+    def delete_file(vector:, file:)
+      vector_id = vector.respond_to?(:id) ? vector.id : vector
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Delete.new("/v1/vector_stores/#{vector_id}/files/#{file_id}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
     private
 
     [:headers, :execute, :set_body_stream].each do |m|

data/lib/llm/providers/openai.rb

@@ -3,7 +3,16 @@
 module LLM
   ##
   # The OpenAI class implements a provider for
-  # [OpenAI](https://platform.openai.com/)
+  # [OpenAI](https://platform.openai.com/).
+  #
+  # @example
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #
+  #   llm = LLM.openai(key: ENV["KEY"])
+  #   bot = LLM::Bot.new(llm)
+  #   bot.chat ["Tell me about this photo", File.open("/images/capybara.jpg", "rb")]
+  #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class OpenAI < Provider
     require_relative "openai/response/embedding"
     require_relative "openai/response/completion"

data/lib/llm/providers/xai/images.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class LLM::XAI
+  ##
+  # The {LLM::XAI::Images LLM::XAI::Images} class provides an interface
+  # for [xAI's images API](https://docs.x.ai/docs/guides/image-generations).
+  # xAI supports multiple response formats: temporary URLs, or binary strings
+  # encoded in base64. The default is to return temporary URLs.
+  #
+  # @example Temporary URLs
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #   require "open-uri"
+  #   require "fileutils"
+  #
+  #   llm = LLM.xai(key: ENV["KEY"])
+  #   res = llm.images.create prompt: "A dog on a rocket to the moon"
+  #   FileUtils.mv OpenURI.open_uri(res.urls[0]).path,
+  #                "rocket.png"
+  #
+  # @example Binary strings
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #
+  #   llm = LLM.xai(key: ENV["KEY"])
+  #   res = llm.images.create prompt: "A dog on a rocket to the moon",
+  #                           response_format: "b64_json"
+  #   IO.copy_stream res.images[0], "rocket.png"
+  class Images < LLM::OpenAI::Images
+    ##
+    # Create an image
+    # @example
+    #   llm = LLM.xai(key: ENV["KEY"])
+    #   res = llm.images.create prompt: "A dog on a rocket to the moon"
+    #   res.urls.each { print _1, "\n"}
+    # @see https://docs.x.ai/docs/guides/image-generations xAI docs
+    # @param [String] prompt The prompt
+    # @param [String] model The model to use
+    # @param [Hash] params Other parameters (see xAI docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def create(model: "grok-2-image-1212", **)
+      super
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def edit(model: "grok-2-image-1212", **)
+      raise NotImplementedError
+    end
+
+    ##
+    # @raise [NotImplementedError]
+    def create_variation(model: "grok-2-image-1212", **)
+      raise NotImplementedError
+    end
+  end
+end