llm.rb 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83248fa3bce285d75952b726cc7d1b097e61b61fb77edd55f39168922a8614c
-  data.tar.gz: 52fa691fad7eaa2e77e24245aba97ea469688f8307f869d533fac47707aa6caf
+  metadata.gz: 1b5d6ed41bd22685f456bdd30f90bb462b1d8c89d63b496862c241cd2a9a11ff
+  data.tar.gz: feb10f6589c89741ed978a5bd9eb96c228649fd4348ff93b7fa222e3a4d6fd1a
 SHA512:
-  metadata.gz: d17e104601295bbbd8dd5bd34fe5378e96367aacb832ddb81b7f0fdfd3fa54f39d98dff6568f3190a4d979de4382a6ebd2eba8ee2fb2cce0e67db2478be9a1df
-  data.tar.gz: d2e6bb0f507bdcf140bd7f44f9edd40c057f061a9b4bc7123a87bdf6fa40a6f16a99642965bdaf81aaaeab5e995a01587c79cd47e19c6a2b5f86e456fa4813a9
+  metadata.gz: b922ffea8f415e50ab5a33e16bfe40d9dc9f8875fefccb6e1ad1afe0001ab3e3b52e2f5389d152ecf65f68913af57b6bada63eff25121a9b0d45013072f813c4
+  data.tar.gz: f930afdee74629503347f2115c0e9a4a734282cbade8591804988d910ac5180ef26a727d937cd496a76a46f3aa100548e61e103b7edaa6b57e35d8aa4552eb2f

data/README.md

@@ -5,12 +5,39 @@ includes OpenAI, Gemini, Anthropic, xAI (grok), DeepSeek, Ollama, and
 LlamaCpp. The toolkit includes full support for chat, streaming, tool calling,
 audio, images, files, and structured outputs (JSON Schema).
 
+The library provides a common, uniform interface for all the providers and
+features it supports, in addition to provider-specific features as well. Keep
+reading to find out more.
+
+## Quick start
+
+#### Demo
+
+<details>
+  <summary>Play</summary>
+  <img src="share/llm-shell/examples/demo.gif/">
+</details>
+
+#### Guides
+
+* [An introduction to RAG](https://0x1eef.github.io/posts/an-introduction-to-rag-with-llm.rb/) &ndash;
+  a blog post that implements the RAG pattern
+* [How to estimate the age of a person in a photo](https://0x1eef.github.io/posts/age-estimation-with-llm.rb/) &ndash;
+  a blog post that implements an age estimation tool
+* [How to edit an image with Gemini](https://0x1eef.github.io/posts/how-to-edit-images-with-gemini/) &ndash;
+  a blog post that implements image editing with Gemini
+
+#### Ecosystem
+
+* [llm-shell](https://github.com/llmrb/llm-shell) &ndash; is a developer-oriented console for Large Language Model communication
+* [llm-spell](https://github.com/llmrb/llm-spell) &ndash; is a utility that can correct spelling mistakes with a Large Language Model
+
 ## Features
 
 #### General
 - ✅ A single unified interface for multiple providers
 - 📦 Zero dependencies outside Ruby's standard library
-- 🚀 Efficient API design that minimizes the number of requests made
+- 🚀 Smart API design that minimizes the number of requests made
 
 #### Chat, Agents
 - 🧠 Stateless and stateful chat via completions and responses API
@@ -44,12 +71,12 @@ breaks things down by provider, so you can see exactly what’s supported where.
 | **Streaming**                        | ✅     | ✅        | ✅     | ✅       | ✅         | ✅     | ✅       |
 | **Tool Calling**                     | ✅     | ✅        | ✅     | ✅       | ✅         | ✅     | ✅       |
 | **JSON Schema / Structured Output**  | ✅     | ❌        | ✅     | ❌       | ✅         | ✅*    | ✅*      |
-| **Audio (TTS / Transcribe / Translate)** | ✅  | ❌        | ✅     | ❌       | ❌         | ❌     | ❌       |
-| **Image Generation & Editing**       | ✅     | ❌        | ✅     | ❌       | ✅         | ❌     | ❌       |
-| **File Uploads**                     | ✅     | ❌        | ✅     | ❌       | ❌         | ❌     | ❌       |
-| **Multimodal Prompts** *(text, documents, audio, images, videos, URLs, etc)* | ✅     | ✅        | ✅     | ✅       | ✅         | ✅     | ✅       |
 | **Embeddings**                       | ✅     | ✅        | ✅     | ✅       | ❌         | ✅     | ✅       |
+| **Multimodal Prompts** *(text, documents, audio, images, videos, URLs, etc)* | ✅     | ✅        | ✅     | ✅       | ✅         | ✅     | ✅       |
+| **Files API**                        | ✅     | ✅        | ✅     | ❌       | ❌         | ❌     | ❌       |
 | **Models API**                       | ✅     | ✅        | ✅     | ✅       | ✅         | ✅     | ✅       |
+| **Audio (TTS / Transcribe / Translate)** | ✅  | ❌        | ✅     | ❌       | ❌         | ❌     | ❌       |
+| **Image Generation & Editing**       | ✅     | ❌        | ✅     | ❌       | ✅         | ❌     | ❌       |
 | **Local Model Support**              | ❌     | ❌        | ❌     | ❌       | ❌         | ✅     | ✅       |
 | **Vector Stores (RAG)**               | ✅     | ❌        | ❌     | ❌       | ❌         | ❌     | ❌       |
 | **Responses**                        | ✅     | ❌        | ❌     | ❌       | ❌         | ❌     | ❌       |
@@ -167,10 +194,10 @@ require "llm"
 ##
 # Objects
 llm = LLM.openai(key: ENV["KEY"])
-schema = llm.schema.object(probability: llm.schema.integer.required)
+schema = llm.schema.object(probability: llm.schema.number.required)
 bot = LLM::Bot.new(llm, schema:)
 bot.chat "Does the earth orbit the sun?", role: :user
-bot.messages.find(&:assistant?).content! # => {probability: 1}
+bot.messages.find(&:assistant?).content! # => {probability: 1.0}
 
 ##
 # Enums
@@ -259,7 +286,7 @@ require "llm"
 llm = LLM.openai(key: ENV["KEY"])
 bot = LLM::Bot.new(llm)
 file = llm.files.create(file: "/books/goodread.pdf")
-bot.chat(["Tell me about this file", file])
+bot.chat ["Tell me about this file", file]
 bot.messages.select(&:assistant?).each { print "[#{_1.role}] ", _1.content, "\n" }
 ```
 
@@ -477,7 +504,7 @@ end
 ##
 # Select a model
 model = llm.models.all.find { |m| m.id == "gpt-3.5-turbo" }
-bot = LLM::Bot.new(llm, model:)
+bot = LLM::Bot.new(llm, model: model.id)
 bot.chat "Hello #{model.id} :)"
 bot.messages.select(&:assistant?).each { print "[#{_1.role}] ", _1.content, "\n" }
 ```
@@ -493,8 +520,12 @@ over or doesn't cover at all. The API reference is available at
 
 ### Guides
 
-* [An introduction to RAG with llm.rb](https://0x1eef.github.io/posts/an-introduction-to-rag-with-llm.rb/) &ndash;
-  a blog post that implements the RAG pattern in 32 lines of Ruby code
+* [An introduction to RAG](https://0x1eef.github.io/posts/an-introduction-to-rag-with-llm.rb/) &ndash;
+  a blog post that implements the RAG pattern
+* [How to estimate the age of a person in a photo](https://0x1eef.github.io/posts/age-estimation-with-llm.rb/) &ndash;
+  a blog post that implements an age estimation tool
+* [How to edit an image with Gemini](https://0x1eef.github.io/posts/how-to-edit-images-with-gemini/) &ndash;
+  a blog post that implements image editing with Gemini
 * [docs/](docs/) &ndash; the docs directory contains additional guides
 
 

data/lib/llm/buffer.rb

@@ -87,6 +87,20 @@ module LLM
       @pending.empty? and @completed.empty?
     end
 
+    ##
+    # @example
+    #   llm = LLM.openai(key: ENV["KEY"])
+    #   bot = LLM::Bot.new(llm, stream: $stdout)
+    #   bot.chat "Hello", role: :user
+    #   bot.messages.drain
+    # @note
+    #   This method is especially useful when using the streaming API.
+    # Drains the buffer and returns all messages as an array
+    # @return [Array<LLM::Message>]
+    def drain
+      to_a
+    end
+
     private
 
     def empty!
@@ -101,23 +115,26 @@ module LLM
     end
 
     def complete!(message, params)
-      pendings = @pending.map { _1[0] }
-      messages = [*@completed, *pendings]
+      oldparams = @pending.map { _1[1] }
+      pendings  = @pending.map { _1[0] }
+      messages  = [*@completed, *pendings]
       role = message.role
       completion = @provider.complete(
         message.content,
-        params.merge(role:, messages:)
+        [*oldparams, params.merge(role:, messages:)].inject({}, &:merge!)
       )
       @completed.concat([*pendings, message, *completion.choices[0]])
       @pending.clear
     end
 
     def respond!(message, params)
-      pendings = @pending.map { _1[0] }
-      input = [*pendings]
+      oldparams = @pending.map { _1[1] }
+      pendings  = @pending.map { _1[0] }
+      messages  = [*pendings]
       role = message.role
       params = [
-        params.merge(input:),
+        *oldparams,
+        params.merge(input: messages),
         @response ? {previous_response_id: @response.id} : {}
       ].inject({}, &:merge!)
       @response = @provider.responses.create(message.content, params.merge(role:))

data/lib/llm/file.rb

@@ -26,7 +26,7 @@ class LLM::File
   # @return [String]
   #  Returns the MIME type of the file
   def mime_type
-    LLM::Mime[File.extname(path)]
+    LLM::Mime[path]
   end
 
   ##

data/lib/llm/message.rb

@@ -117,6 +117,13 @@ module LLM
         [*content].grep(LLM::Function::Return).any?
     end
 
+    ##
+    # @return [LLM::Response, nil]
+    #  Returns the response associated with the message, or nil
+    def response
+      extra[:response]
+    end
+
     ##
     # Returns a string representation of the message
     # @return [String]

data/lib/llm/mime.rb

@@ -3,12 +3,16 @@
 ##
 # @private
 class LLM::Mime
+  EXTNAME = /\A\.[a-zA-Z0-9]+\z/
+  private_constant :EXTNAME
+
   ##
   # Lookup a mime type
   # @return [String, nil]
   def self.[](key)
-    key = key.respond_to?(:path) ? File.extname(key.path) : key
-    types[key] || "application/octet-stream"
+    key = key.respond_to?(:path) ? key.path : key
+    extname = (key =~ EXTNAME) ? key : File.extname(key)
+    types[extname] || "application/octet-stream"
   end
 
   ##

data/lib/llm/provider.rb

@@ -284,7 +284,8 @@ class LLM::Provider
         parser&.free
       end
     else
-      client.request(request, &b)
+      b ? client.request(request) { (Net::HTTPSuccess === _1) ? b.call(_1) : _1 } :
+          client.request(request)
     end
     handle_response(res)
   end

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+class LLM::Anthropic
+  ##
+  # The {LLM::Anthropic::Files LLM::Anthropic::Files} class provides a files
+  # object for interacting with [Anthropic's Files API](https://docs.anthropic.com/en/docs/build-with-claude/files).
+  #
+  # @example
+  #   #!/usr/bin/env ruby
+  #   require "llm"
+  #
+  #   llm = LLM.anthropic(key: ENV["KEY"])
+  #   bot = LLM::Bot.new(llm)
+  #   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"
+    ##
+    # Returns a new Files object
+    # @param provider [LLM::Provider]
+    # @return [LLM::Anthropic::Files]
+    def initialize(provider)
+      @provider = provider
+    end
+
+    ##
+    # List all files
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.all
+    #   res.each do |file|
+    #     print "id: ", file.id, "\n"
+    #   end
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @param [Hash] params Other parameters (see Anthropic docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def all(**params)
+      query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new("/v1/files?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res).extend(LLM::Anthropic::Response::Enumerable)
+    end
+
+    ##
+    # Create a file
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.create file: "/documents/haiku.txt"
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @param [File, LLM::File, String] file The file
+    # @param [Hash] params Other parameters (see Anthropic docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def create(file:, **params)
+      multi = LLM::Multipart.new(params.merge!(file: LLM.File(file)))
+      req = Net::HTTP::Post.new("/v1/files", headers)
+      req["content-type"] = multi.content_type
+      set_body_stream(req, multi.body)
+      res = execute(request: req)
+      LLM::Response.new(res).extend(LLM::Anthropic::Response::File)
+    end
+
+    ##
+    # Get a file
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.get(file: "file-1234567890")
+    #   print "id: ", res.id, "\n"
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @param [#id, #to_s] file The file ID
+    # @param [Hash] params Other parameters - if any (see Anthropic docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def get(file:, **params)
+      file_id = file.respond_to?(:id) ? file.id : file
+      query = URI.encode_www_form(params)
+      req = Net::HTTP::Get.new("/v1/files/#{file_id}?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res).extend(LLM::Anthropic::Response::File)
+    end
+
+    ##
+    # Retrieve file metadata
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.get_metadata(file: "file-1234567890")
+    #   print "id: ", res.id, "\n"
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files
+    # @param [#id, #to_s] file The file ID
+    # @param [Hash] params Other parameters - if any (see Anthropic docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def get_metadata(file:, **params)
+      query = URI.encode_www_form(params)
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Get.new("/v1/files/#{file_id}?#{query}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res).extend(LLM::Anthropic::Response::File)
+    end
+    alias_method :retrieve_metadata, :get_metadata
+
+    ##
+    # Delete a file
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.delete(file: "file-1234567890")
+    #   print res.deleted, "\n"
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @param [#id, #to_s] file The file ID
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def delete(file:)
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Delete.new("/v1/files/#{file_id}", headers)
+      res = execute(request: req)
+      LLM::Response.new(res)
+    end
+
+    ##
+    # Download the contents of a file
+    # @note
+    #   You can only download files that were created by the code
+    #   execution tool. Files that you uploaded cannot be downloaded.
+    # @example
+    #   llm = LLM.anthropic(key: ENV["KEY"])
+    #   res = llm.files.download(file: "file-1234567890")
+    #   File.binwrite "program.c", res.file.read
+    #   print res.file.read, "\n"
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @param [#id, #to_s] file The file ID
+    # @param [Hash] params Other parameters (see Anthropic docs)
+    # @raise (see LLM::Provider#request)
+    # @return [LLM::Response]
+    def download(file:, **params)
+      query = URI.encode_www_form(params)
+      file_id = file.respond_to?(:id) ? file.id : file
+      req = Net::HTTP::Get.new("/v1/files/#{file_id}/content?#{query}", headers)
+      io = StringIO.new("".b)
+      res = execute(request: req) { |res| res.read_body { |chunk| io << chunk } }
+      LLM::Response.new(res).tap { _1.define_singleton_method(:file) { io } }
+    end
+
+    private
+
+    def key
+      @provider.instance_variable_get(:@key)
+    end
+
+    [:headers, :execute, :set_body_stream].each do |m|
+      define_method(m) { |*args, **kwargs, &b| @provider.send(m, *args, **kwargs, &b) }
+    end
+  end
+end

data/lib/llm/providers/anthropic/format/completion_format.rb

@@ -60,6 +60,12 @@ module LLM::Anthropic::Format
                                   "is not an image or PDF, and therefore not supported by the " \
                                   "Anthropic API"
         end
+      when LLM::Response
+        if content.file?
+          [{type: content.file_type, source: {type: :file, file_id: content.id}}]
+        else
+          prompt_error!(content)
+        end
       when String
         [{type: :text, text: content}]
       when LLM::Message
@@ -67,11 +73,15 @@ module LLM::Anthropic::Format
       when LLM::Function::Return
         [{type: "tool_result", tool_use_id: content.id, content: [{type: :text, text: JSON.dump(content.value)}]}]
       else
-        raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
-                                "is not supported by the Anthropic API"
+        prompt_error!(content)
       end
     end
 
+    def prompt_error!(content)
+      raise LLM::PromptError, "The given object (an instance of #{content.class}) " \
+                              "is not supported by the Anthropic API"
+    end
+
     def message = @message
     def content = message.content
   end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 class LLM::Anthropic
+  require_relative "response/enumerable"
   ##
   # The {LLM::Anthropic::Models LLM::Anthropic::Models} class provides a model
   # object for interacting with [Anthropic's models API](https://platform.anthropic.com/docs/api-reference/models/list).
@@ -41,7 +42,7 @@ class LLM::Anthropic
       query = URI.encode_www_form(params)
       req = Net::HTTP::Get.new("/v1/models?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::Anthropic::Response::Enumerable)
     end
 
     private

data/lib/llm/providers/anthropic/response/enumerable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LLM::Anthropic::Response
+  module Enumerable
+    include ::Enumerable
+    def each(&)
+      return enum_for(:each) unless block_given?
+      data.each { yield(_1) }
+    end
+  end
+end

data/lib/llm/providers/anthropic/response/file.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module LLM::Anthropic::Response
+  module File
+    ##
+    # Always return true
+    # @return [Boolean]
+    def file? = true
+
+    ##
+    # Returns the file type referenced by a prompt
+    # @return [Symbol]
+    def file_type
+      if mime_type.start_with?("image/")
+        :image
+      elsif mime_type == "text/plain" || mime_type == "application/pdf"
+        :document
+      else
+        :container_upload
+      end
+    end
+  end
+end

data/lib/llm/providers/anthropic.rb

@@ -18,6 +18,7 @@ module LLM
     require_relative "anthropic/format"
     require_relative "anthropic/error_handler"
     require_relative "anthropic/stream_parser"
+    require_relative "anthropic/files"
     require_relative "anthropic/models"
     include Format
 
@@ -60,6 +61,14 @@ module LLM
       LLM::Anthropic::Models.new(self)
     end
 
+    ##
+    # Provides an interface to Anthropic's files API
+    # @see https://docs.anthropic.com/en/docs/build-with-claude/files Anthropic docs
+    # @return [LLM::Anthropic::Files]
+    def files
+      LLM::Anthropic::Files.new(self)
+    end
+
     ##
     # @return (see LLM::Provider#assistant_role)
     def assistant_role
@@ -80,7 +89,8 @@ module LLM
       (@headers || {}).merge(
         "Content-Type" => "application/json",
         "x-api-key" => @key,
-        "anthropic-version" => "2023-06-01"
+        "anthropic-version" => "2023-06-01",
+        "anthropic-beta" => "files-api-2025-04-14"
       )
     end
 

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

@@ -24,6 +24,7 @@ class LLM::Gemini
   #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class Files
     require_relative "response/file"
+    require_relative "response/files"
 
     ##
     # Returns a new Files object
@@ -49,7 +50,7 @@ class LLM::Gemini
       query = URI.encode_www_form(params.merge!(key: key))
       req = Net::HTTP::Get.new("/v1beta/files?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::Gemini::Response::Files)
     end
 
     ##

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

@@ -17,6 +17,7 @@ class LLM::Gemini
   #     print "id: ", model.id, "\n"
   #   end
   class Models
+    require_relative "response/models"
     include LLM::Utils
 
     ##
@@ -43,7 +44,7 @@ class LLM::Gemini
       query = URI.encode_www_form(params.merge!(key: key))
       req = Net::HTTP::Get.new("/v1beta/models?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::Gemini::Response::Models)
     end
 
     private

data/lib/llm/providers/gemini/response/files.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LLM::Gemini::Response
+  module Files
+    include ::Enumerable
+    def each(&)
+      return enum_for(:each) unless block_given?
+      files.each { yield(_1) }
+    end
+
+    def files
+      body.files || []
+    end
+  end
+end

data/lib/llm/providers/gemini/response/models.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LLM::Gemini::Response
+  module Models
+    include ::Enumerable
+    def each(&)
+      return enum_for(:each) unless block_given?
+      models.each { yield(_1) }
+    end
+
+    def models
+      body.models || []
+    end
+  end
+end

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

@@ -18,6 +18,7 @@ class LLM::OpenAI
   #   bot.chat ["Tell me about this PDF", file]
   #   bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }
   class Files
+    require_relative "response/enumerable"
     require_relative "response/file"
 
     ##
@@ -44,7 +45,7 @@ class LLM::OpenAI
       query = URI.encode_www_form(params)
       req = Net::HTTP::Get.new("/v1/files?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Enumerable)
     end
 
     ##

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

@@ -17,6 +17,8 @@ class LLM::OpenAI
   #     print "id: ", model.id, "\n"
   #   end
   class Models
+    require_relative "response/enumerable"
+
     ##
     # Returns a new Models object
     # @param provider [LLM::Provider]
@@ -41,7 +43,7 @@ class LLM::OpenAI
       query = URI.encode_www_form(params)
       req = Net::HTTP::Get.new("/v1/models?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Enumerable)
     end
 
     private

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LLM::OpenAI::Response
+  module Enumerable
+    include ::Enumerable
+    def each(&)
+      return enum_for(:each) unless block_given?
+      data.each { yield(_1) }
+    end
+  end
+end

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

@@ -80,5 +80,13 @@ class LLM::OpenAI
      :format_tools].each do |m|
       define_method(m) { |*args, **kwargs, &b| @provider.send(m, *args, **kwargs, &b) }
     end
+
+    def format_schema(params)
+      return {} unless params && params[:schema]
+      schema = params.delete(:schema)
+      schema = schema.to_h.merge(additionalProperties: false)
+      name = "JSONSchema"
+      {text: {format: {type: "json_schema", name:, schema:}}}
+    end
   end
 end

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

@@ -5,6 +5,8 @@ class LLM::OpenAI
   # 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
+    require_relative "response/enumerable"
+
     ##
     # @param [LLM::Provider] provider
     #  An OpenAI provider
@@ -20,7 +22,7 @@ class LLM::OpenAI
       query = URI.encode_www_form(params)
       req = Net::HTTP::Get.new("/v1/vector_stores?#{query}", headers)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Enumerable)
     end
 
     ##
@@ -93,7 +95,7 @@ class LLM::OpenAI
       req = Net::HTTP::Post.new("/v1/vector_stores/#{vector_id}/search", headers)
       req.body = JSON.dump(params.merge({query:}).compact)
       res = execute(request: req)
-      LLM::Response.new(res)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Enumerable)
     end
 
     ##
@@ -108,7 +110,7 @@ class LLM::OpenAI
       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)
+      LLM::Response.new(res).extend(LLM::OpenAI::Response::Enumerable)
     end
 
     ##

data/lib/llm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Antar Azri
@@ -186,10 +186,13 @@ files:
 - lib/llm/provider.rb
 - lib/llm/providers/anthropic.rb
 - lib/llm/providers/anthropic/error_handler.rb
+- lib/llm/providers/anthropic/files.rb
 - lib/llm/providers/anthropic/format.rb
 - lib/llm/providers/anthropic/format/completion_format.rb
 - lib/llm/providers/anthropic/models.rb
 - lib/llm/providers/anthropic/response/completion.rb
+- lib/llm/providers/anthropic/response/enumerable.rb
+- lib/llm/providers/anthropic/response/file.rb
 - lib/llm/providers/anthropic/stream_parser.rb
 - lib/llm/providers/deepseek.rb
 - lib/llm/providers/deepseek/format.rb
@@ -205,7 +208,9 @@ files:
 - lib/llm/providers/gemini/response/completion.rb
 - lib/llm/providers/gemini/response/embedding.rb
 - lib/llm/providers/gemini/response/file.rb
+- lib/llm/providers/gemini/response/files.rb
 - lib/llm/providers/gemini/response/image.rb
+- lib/llm/providers/gemini/response/models.rb
 - lib/llm/providers/gemini/stream_parser.rb
 - lib/llm/providers/llamacpp.rb
 - lib/llm/providers/ollama.rb
@@ -230,6 +235,7 @@ files:
 - lib/llm/providers/openai/response/audio.rb
 - lib/llm/providers/openai/response/completion.rb
 - lib/llm/providers/openai/response/embedding.rb
+- lib/llm/providers/openai/response/enumerable.rb
 - lib/llm/providers/openai/response/file.rb
 - lib/llm/providers/openai/response/image.rb
 - lib/llm/providers/openai/response/moderations.rb