llm.rb 0.16.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38502ab4a41dba8177cb7b21db68f3e0dd5492323ac8b132b1775926b46ffffc
-  data.tar.gz: ebe196962c43934ae979e298f80b4bc2e30a147ad0f42595eef59880be9fc01e
+  metadata.gz: 01f2984f551757482fbf590485875bef064060d27eb84d3d4325e307db1029c5
+  data.tar.gz: a492d121a5dc1916412296269cf0055ce14512855fecb94e2b018dcefb9b404d
 SHA512:
-  metadata.gz: 5100d71b851771137a86e799bc2cadab360fc0ced297288b09fa701a8f434c671fe739427b889243e9704c5ae2a05b6b8761c85f0b0bea9268700bf770e80f13
-  data.tar.gz: 3aed0f826c229a37d30b2f0d41678976ba00df72216588a9302320c52e22d9d1b814df0b76bca8f6e713e105d73006339121a8bb900a73ac8896cc1f7c3f0051
+  metadata.gz: 341d074d9d732056599d6f27865f8fcf3fecd0f6062de73ec5dffcd056031e727c43f8058c472d69b598ae3fa4232bb47b960b331b20b8f7cc9323a86e9beeb7
+  data.tar.gz: aa9c19a4b51b8c379f6d8a8f486172e332d6ca1fb4a3f65fa2b32ff7685a3f48fd6d5db0092bcc3a97fca7f36b4f4214df1dfd675ad1215a172e5ae9ce76cc00

data/README.md

@@ -34,6 +34,25 @@ GitHub Copilot but for the terminal.
 * [llm-shell](https://github.com/llmrb/llm-shell) – a developer-oriented console for Large Language Model communication
 * [llm-spell](https://github.com/llmrb/llm-spell) – a utility that can correct spelling mistakes with a Large Language Model
 
+#### Show code
+
+A simple chatbot that maintains a conversation and streams
+responses in real-time:
+
+```ruby
+#!/usr/bin/env ruby
+require "llm"
+
+llm = LLM.openai(key: ENV["KEY"])
+bot = LLM::Bot.new(llm, stream: $stdout)
+loop do
+  print "> "
+  input = $stdin.gets&.chomp || break
+  bot.chat(input).flush
+  print "\n"
+end
+```
+
 ## Features
 
 #### General
@@ -129,9 +148,11 @@ and the gem should be installed separately:
 #!/usr/bin/env ruby
 require "llm"
 
-llm = LLM.openai(key: ENV["KEY"], persistent: true)
-res = llm.responses.create "Hello world"
-llm.responses.create "Adios", last_response_id: res.response_id
+llm  = LLM.openai(key: ENV["KEY"], persistent: true)
+res1 = llm.responses.create "message 1"
+res2 = llm.responses.create "message 2", previous_response_id: res1.response_id
+res3 = llm.responses.create "message 3", previous_response_id: res2.response_id
+print res3.output_text, "\n"
 ```
 
 ### Conversations
@@ -195,7 +216,7 @@ bot.chat(stream: $stdout) do |prompt|
   prompt.user ["Tell me about this URL", URI(url)]
   prompt.user ["Tell me about this PDF", File.open("handbook.pdf", "rb")]
   prompt.user "Are the URL and PDF similar to each other?"
-end.to_a
+end.flush
 ```
 
 ### Schema

data/lib/llm/bot.rb

@@ -123,5 +123,17 @@ module LLM
         .flat_map(&:functions)
         .select(&:pending?)
     end
+
+    ##
+    # @example
+    #   llm = LLM.openai(key: ENV["KEY"])
+    #   bot = LLM::Bot.new(llm, stream: $stdout)
+    #   bot.chat("Hello", role: :user).flush
+    # Drains the buffer and returns all messages as an array
+    # @return [Array<LLM::Message>]
+    def drain
+      messages.drain
+    end
+    alias_method :flush, :drain
   end
 end

data/lib/llm/buffer.rb

@@ -65,12 +65,20 @@ module LLM
     alias_method :push, :<<
 
     ##
-    # @param [Integer, #to_i] index
+    # @param [Integer, Range, #to_i] index
     #  The message index
     # @return [LLM::Message, nil]
     #  Returns a message, or nil
     def [](index)
-      @completed[index.to_i] || to_a[index.to_i]
+      if index.respond_to?(:to_i)
+        @completed[index.to_i] || to_a[index.to_i]
+      elsif Range === index
+        slice = @completed[index]
+        invalidate = slice.nil? || slice.size < index.size
+        invalidate ? to_a[index] : slice
+      else
+        raise TypeError, "index must be an Integer or Range"
+      end
     end
 
     ##
@@ -92,7 +100,8 @@ module LLM
     #   llm = LLM.openai(key: ENV["KEY"])
     #   bot = LLM::Bot.new(llm, stream: $stdout)
     #   bot.chat "Hello", role: :user
-    #   bot.messages.drain
+    #   bot.messages.flush
+    # @see LLM::Bot#drain
     # @note
     #   This method is especially useful when using the streaming API.
     # Drains the buffer and returns all messages as an array
@@ -100,6 +109,7 @@ module LLM
     def drain
       to_a
     end
+    alias_method :flush, :drain
 
     private
 

data/lib/llm/error.rb

@@ -35,6 +35,10 @@ module LLM
   # HTTPServerError
   ServerError = Class.new(ResponseError)
 
+  ##
+  # When no images are found in a response
+  NoImageError = Class.new(ResponseError)
+
   ##
   # When an given an input object that is not understood
   FormatError = Class.new(Error)

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

@@ -36,12 +36,13 @@ class LLM::Gemini
     # @param [String] prompt The prompt
     # @param [Hash] params Other parameters (see Gemini docs)
     # @raise (see LLM::Provider#request)
+    # @raise [LLM::NoImageError] when no images are returned
     # @note
     #  The prompt should make it clear you want to generate an image, or you
     #  might unexpectedly receive a purely textual response. This is due to how
     #  Gemini implements image generation under the hood.
     # @return [LLM::Response]
-    def create(prompt:, model: "gemini-2.0-flash-exp-image-generation", **params)
+    def create(prompt:, model: "gemini-2.5-flash-image-preview", **params)
       req  = Net::HTTP::Post.new("/v1beta/models/#{model}:generateContent?key=#{key}", headers)
       body = JSON.dump({
         contents: [{parts: [{text: create_prompt}, {text: prompt}]}],
@@ -49,7 +50,7 @@ class LLM::Gemini
       }.merge!(params))
       req.body = body
       res = execute(request: req)
-      LLM::Response.new(res).extend(LLM::Gemini::Response::Image)
+      validate LLM::Response.new(res).extend(LLM::Gemini::Response::Image)
     end
 
     ##
@@ -63,9 +64,10 @@ class LLM::Gemini
     # @param [String] prompt The prompt
     # @param [Hash] params Other parameters (see Gemini docs)
     # @raise (see LLM::Provider#request)
+    # @raise [LLM::NoImageError] when no images are returned
     # @note (see LLM::Gemini::Images#create)
     # @return [LLM::Response]
-    def edit(image:, prompt:, model: "gemini-2.0-flash-exp-image-generation", **params)
+    def edit(image:, prompt:, model: "gemini-2.5-flash-image-preview", **params)
       req   = Net::HTTP::Post.new("/v1beta/models/#{model}:generateContent?key=#{key}", headers)
       image = LLM.File(image)
       body  = JSON.dump({
@@ -74,7 +76,7 @@ class LLM::Gemini
       }.merge!(params)).b
       set_body_stream(req, StringIO.new(body))
       res = execute(request: req)
-      LLM::Response.new(res).extend(LLM::Gemini::Response::Image)
+      validate LLM::Response.new(res).extend(LLM::Gemini::Response::Image)
     end
 
     ##
@@ -119,6 +121,11 @@ class LLM::Gemini
       PROMPT
     end
 
+    def validate(res)
+      return res unless res.images.empty?
+      raise LLM::NoImageError.new { _1.response = res.res }, "no images found in response"
+    end
+
     [:headers, :execute, :set_body_stream].each do |m|
       define_method(m) { |*args, **kwargs, &b| @provider.send(m, *args, **kwargs, &b) }
     end

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

@@ -22,5 +22,10 @@ module LLM::Gemini::Response
     #  will always return an empty array.
     # @return [Array<String>]
     def urls = []
+
+    ##
+    # Returns one or more candidates, or an empty array
+    # @return [Array<Hash>]
+    def candidates = body.candidates || []
   end
 end

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

@@ -8,8 +8,7 @@ class LLM::OpenAI
   # @example
   #  llm = LLM.openai(key: ENV["OPENAI_SECRET"])
   #  files = %w(foo.pdf bar.pdf).map { llm.files.create(file: _1) }
-  #  store = llm.vector_stores.create(name: "PDF Store", file_ids: files.map(&:id))
-  #  store = llm.vector_stores.poll(vector: store)
+  #  store = llm.vector_stores.create_and_poll(name: "PDF Store", file_ids: files.map(&:id))
   #  print "[-] store is ready", "\n"
   #  chunks = llm.vector_stores.search(vector: store, query: "What is Ruby?")
   #  chunks.each { |chunk| puts chunk }
@@ -50,6 +49,14 @@ class LLM::OpenAI
       LLM::Response.new(res)
     end
 
+    ##
+    # Create a vector store and poll until its status is "completed"
+    # @param (see LLM::OpenAI::VectorStores#create)
+    # @return (see LLM::OpenAI::VectorStores#poll)
+    def create_and_poll(...)
+      poll(vector: create(...))
+    end
+
     ##
     # Get a vector store
     # @param [String, #id] vector The ID of the vector store

data/lib/llm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.2
 platform: ruby
 authors:
 - Antar Azri