llm.rb 12.6.0 → 13.0.0

data/lib/llm/repl/markdown/table.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class LLM::Repl::Markdown
+  ##
+  # Renders Kramdown `:table` nodes as aligned columns.
+  module Table
+    ##
+    # Renders a table node by collecting all cells first to
+    # compute column widths, then emitting each row with
+    # padded text.
+    def walk_table(node, attrs)
+      rows = collect_rows(node, attrs)
+      return if rows.empty?
+      widths = column_widths(rows)
+      rows.each do |row|
+        emit("| ", attrs)
+        row.each_with_index do |chunks, i|
+          text = chunks.map { _1[:text] }.join
+          width = widths[i]
+          chunks.each { |c| emit(c[:text].ljust(width), c[:attrs]) }
+          emit(" | ", attrs) unless i == row.size - 1
+        end
+        emit(" |", attrs)
+        emit("\n", attrs)
+      end
+      emit("\n", attrs)
+    end
+
+    private
+
+    def collect_rows(node, attrs)
+      node.children.each_with_object([]) do |section, rows|
+        next unless [:thead, :tbody].include?(section.type)
+        section.children.each do |tr|
+          next unless tr.type == :tr
+          cells = tr.children.filter_map do |td|
+            next unless [:td, :th].include?(td.type)
+            collect_chunks(td, attrs)
+          end
+          rows << cells
+        end
+      end
+    end
+
+    def collect_chunks(node, attrs)
+      [].tap do |chunks|
+        walk_collect(node, attrs, chunks)
+      end
+    end
+
+    def walk_collect(node, attrs, chunks)
+      case node.type
+      when :text
+        chunks << {text: node.value.to_s, attrs:}
+      when :strong
+        node.children.each { walk_collect(_1, Curses::A_BOLD, chunks) }
+      when :em
+        node.children.each { walk_collect(_1, Curses::A_UNDERLINE, chunks) }
+      when :codespan
+        chunks << {text: node.value, attrs: Curses::A_REVERSE}
+      when :a
+        node.children.each { walk_collect(_1, Curses::A_UNDERLINE, chunks) }
+      else
+        node.children.each { walk_collect(_1, attrs, chunks) }
+      end
+    end
+
+    def column_widths(rows)
+      return [] if rows.empty?
+      cols = rows.first.size
+      (0...cols).map do |i|
+        rows.map { |r| r[i].map { _1[:text] }.join.length }.max
+      end
+    end
+  end
+end

data/lib/llm/repl/markdown.rb

@@ -8,11 +8,16 @@ class LLM::Repl
   # of text, and also optional style information for
   # that text (eg bold, underscore, ...)
   class Markdown
+    require_relative "markdown/table"
+    include Table
+
     ##
     # @param [String] text
+    # @param [Integer] width
     # @return [LLM::Repl::Markdown]
-    def initialize(text)
+    def initialize(text, width)
       @doc = Kramdown::Document.new(text)
+      @width = width
       @ast = []
     end
 
@@ -73,6 +78,31 @@ class LLM::Repl
         emit("\n\n", attrs)
       when :br
         emit("\n", attrs)
+      when :ul, :ol
+        node.children.each { walk(_1, attrs) }
+      when :li
+        node.children.each { walk(_1, attrs) }
+      when :table
+        walk_table(node, attrs)
+      when :thead, :tbody
+        node.children.each { walk(_1, attrs) }
+      when :tr
+        emit("| ", attrs)
+        node.children.each { walk(_1, attrs) }
+        emit("\n", attrs)
+      when :td, :th
+        node.children.each { walk(_1, attrs) }
+        emit(" | ", attrs)
+      when :blockquote
+        emit("> ", attrs)
+        node.children.each { walk(_1, attrs) }
+      when :hr
+        emit("─" * @width, attrs)
+        emit("\n\n", attrs)
+      when :a
+        node.children.each { walk(_1, Curses::A_UNDERLINE) }
+      when :img
+        emit("[image: #{node.attr['alt']}]", attrs)
       else
         node.children.each { walk(_1, attrs) }
       end

data/lib/llm/repl/status.rb

@@ -7,7 +7,7 @@ class LLM::Repl
   # @api private
   class Status
     ##
-    # @param [String, Symbol] provider
+    # @param [LLM::Agent] agent
     # @return [LLM::Repl::Status]
     def initialize(agent)
       @agent = agent

data/lib/llm/repl/stream.rb

@@ -60,9 +60,16 @@ class LLM::Repl
     # @param [Integer] max
     # @return [String]
     def format_args(tool, max: 50)
-      args = tool.arguments
-      pairs = args.to_h.map { "#{_1}: #{format_value(_2)}" }
-      result = pairs.join(", ")
+      ##
+      # 'tool.arguments' might be returned
+      # (by the model) in a different order
+      # than the tool definition - this code
+      # handles re-sorting.
+      args   = tool.arguments
+      props  = tool.params.properties.keys
+      props  = props.sort_by { tool.params.properties[_1].index }
+      props  = props.filter_map { args[_1] ? "#{_1}: #{format_value(args[_1])}" : nil }
+      result = props.join(", ")
       result.size > max ? "#{result[0...max - 1]}…" : result
     end
 

data/lib/llm/repl/transcript.rb

@@ -42,7 +42,7 @@ class LLM::Repl
     # @param [Symbol] method
     # @return [void]
     def markdown(chars, method: :append)
-      chunks = LLM::Repl::Markdown.new(chars).ast
+      chunks = LLM::Repl::Markdown.new(chars, WIDTH).ast
       self.method(method).call(chunks)
     end
 

data/lib/llm/repl/walker.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class LLM::Repl
+  ##
+  # Walks through an array from the last element backward,
+  # one step at a time. {#next} moves forward toward the end.
+  # Both methods clamp at the array boundaries.
+  class Walker
+    ##
+    # Sets the cursor position
+    attr_writer :cursor
+
+    ##
+    # @param [Array] items
+    def initialize(items)
+      @items = items
+      @cursor = items.size
+    end
+
+    ##
+    # @return [Object, nil]
+    def next
+      if @items.empty?
+        nil
+      elsif @cursor >= @items.size - 1
+        @items[@cursor]
+      else
+        @cursor += 1
+        @items[@cursor]
+      end
+    end
+
+    ##
+    # @return [Object, nil]
+    def prev
+      if @items.empty?
+        nil
+      elsif @cursor <= 0
+        @items[@cursor]
+      else
+        @cursor -= 1
+        @items[@cursor]
+      end
+    end
+  end
+end

data/lib/llm/repl.rb

@@ -23,9 +23,17 @@ module LLM
     require_relative "repl/stream"
     require_relative "repl/markdown"
     require_relative "repl/command"
+    require_relative "repl/walker"
+
+    attr_reader :agent, :provider, :stream,
+                :status, :transcript, :input,
+                :window, :tools, :thread,
+                :name, :path
 
     ##
     # @param [LLM::Agent] agent
+    # @param [String, nil] name
+    #  The agent's name (optional)
     # @param [String, nil] path
     #  The path where to maintain runtime state
     # @param [Array<LLM::Tool>] tools
@@ -33,13 +41,14 @@ module LLM
     # @param [Array<String>] skills
     #  Zero or more skills
     # @return [LLM::Repl]
-    def initialize(agent:, tools: [], skills: [], path: nil)
-      @path  = path
+    def initialize(agent:, name: nil, tools: [], skills: [], path: nil)
+      @path = path
+      @name = name || "agent"
       @agent = configure(agent:, path:)
       @provider = agent.llm.name
       @status = Status.new(@agent)
       @transcript = Transcript.new
-      @input = Input.new(@agent, height: 3)
+      @input = Input.new(self, height: 3)
       @window = Window.new(@status, @transcript, @input)
       @thread = nil
       @queue = Queue.new
@@ -150,7 +159,7 @@ module LLM
         status.text = thinking_text
         write("user: ", Curses::A_BOLD)
         markdown(text)
-        write("\nagent: ", Curses::A_BOLD)
+        write("\n#{name}: ", Curses::A_BOLD)
         @thread = Thread.new do
           @queue << [:start]
           agent.talk(text, tools:, stream:)
@@ -181,12 +190,14 @@ module LLM
            "command(#{command.name}): ",
            "too few arguments: expected #{reqc} but got #{args.size}\n\n"]
         else
+          parameters = parameters.sort_by(&:index).to_h
+          kwargs = {}
           parameters.each_value do |parameter|
             if args[parameter.index]
-              parameter.value = args[parameter.index]
+              kwargs[parameter.name] = args[parameter.index]
             end
           end
-          [:command, command.new(self), parameters.transform_values(&:value)]
+          [:command, command.new(self), kwargs]
         end
       else
         [:input, text]
@@ -216,7 +227,7 @@ module LLM
           @thread = nil
         when :cancel
           status.text = "Idle"
-          write("\n\nagent: ", Curses::A_BOLD)
+          write("\n\n#{name}: ", Curses::A_BOLD)
           write("request cancelled!")
           write("\n\n")
           transcript.finish
@@ -246,11 +257,6 @@ module LLM
       File.readable?(path)
     end
 
-    attr_reader :agent, :provider, :stream,
-                :status, :transcript, :input,
-                :window, :tools, :thread,
-                :path
-
     File = ::File
     private_constant :File
   end

data/lib/llm/response.rb

@@ -10,12 +10,22 @@ module LLM
   # handling can share one common surface without flattening away
   # specialized behavior.
   #
+  # @example Accessing response data
+  #   res = agent.talk "Weather in Paris?", schema: Weather
+  #   res.content        # => raw text or structured data
+  #   res.content!       # => parsed JSON as LLM::Object
+  #   res.usage          # => token usage (input, output, cache, etc.)
+  #   res.messages       # => message history from this turn
+  #
   # The normalized response keeps the transport response available
   # through {#res}. When the default net/http transport is in use,
   # {LLM::Transport::Response::HTTP
   # LLM::Transport::Response::HTTP} keeps the
   # original `Net::HTTPResponse` available through
   # its own {LLM::Transport::Response::HTTP#res #res}.
+  #
+  # @see LLM::Context Responses are returned by Context#talk
+  # @see LLM::Agent Responses are returned by Agent#talk
   class Response
     require "json"
 

data/lib/llm/schema/leaf.rb

@@ -8,12 +8,17 @@ class LLM::Schema
   # an example of how to create instances of {LLM::Schema::Leaf LLM::Schema::Leaf}
   # through its subclasses.
   class Leaf
+    ##
+    # @return [Integer, nil]
+    attr_accessor :index
+
     def initialize
       @description = nil
       @default = nil
       @enum = nil
       @required = nil
       @const = nil
+      @index = nil
     end
 
     ##

data/lib/llm/schema/object.rb

@@ -16,21 +16,22 @@ class LLM::Schema
     #  A hash of properties
     # @return [LLM::Schema::Object]
     def initialize(properties)
-      @properties = properties
+      @properties = LLM::Object.new
+      properties.each { set!(_1, _2) }
     end
 
     ##
     # Get a property
     # @return [LLM::Schema::Leaf]
     def [](key)
-      properties[key.to_s]
+      properties[key]
     end
 
     ##
     # Set a property
     # @return [void]
     def []=(key, val)
-      properties[key.to_s] = val
+      set!(key, val)
     end
 
     ##
@@ -46,7 +47,7 @@ class LLM::Schema
     #  Returns self
     def merge!(other)
       raise TypeError, "expected #{self.class} but got #{other.class}" unless self.class === other
-      @properties.merge!(other.properties)
+      other.properties.each { |key, val| self[key] = val }
       self
     end
 
@@ -64,8 +65,13 @@ class LLM::Schema
 
     private
 
+    def set!(key, val)
+      val.index = @properties.size
+      properties[key] = val
+    end
+
     def required_items
-      @properties.filter_map {  _2.required? ? _1 : nil }
+      @properties.filter_map { _2.required? ? _1 : nil }
     end
   end
 end

data/lib/llm/sequel/plugin.rb

@@ -204,17 +204,17 @@ module LLM::Sequel
     end
 
     ##
-    # @see LLM::Context#functions
+    # @see LLM::Context#pending_functions
     # @return [Array<LLM::Function>]
-    def functions
-      ctx.functions
+    def pending_functions
+      ctx.pending_functions
     end
 
     ##
-    # @see LLM::Context#functions?
+    # @see LLM::Context#pending_functions?
     # @return [Boolean]
-    def functions?
-      ctx.functions?
+    def pending_functions?
+      ctx.pending_functions?
     end
 
     ##

data/lib/llm/stream.rb

@@ -11,6 +11,21 @@ module LLM
   # a small helper for collecting asynchronous tool work started from a
   # callback.
   #
+  # @example Subclass with callbacks
+  #   class MyStream < LLM::Stream
+  #     def on_content(content)
+  #       print content
+  #     end
+  #
+  #     def on_reasoning_content(content)
+  #       warn content
+  #     end
+  #   end
+  #
+  #   llm = LLM.deepseek(key: ENV["KEY"])
+  #   agent = LLM::Agent.new(llm, stream: MyStream.new)
+  #   agent.talk "Explain Ruby fibers."
+  #
   # @note The `on_*` callbacks run inline with the streaming parser. They
   #   therefore block streaming progress and should generally return as
   #   quickly as possible.
@@ -19,6 +34,9 @@ module LLM
   # Providers may also call {#on_reasoning_content} and {#on_tool_call} when
   # that data is available. Runtime features such as context compaction may
   # also emit lifecycle callbacks like {#on_transform} or {#on_compaction}.
+  #
+  # @see LLM::Agent Where streams are typically attached
+  # @see LLM::Context Where streams are bound per-turn
   class Stream
     require_relative "stream/queue"
     require_relative "stream/io"
@@ -109,16 +127,8 @@ module LLM
 
     ##
     # Called when a streamed tool call has been fully constructed.
-    # @note A stream implementation may start tool execution here, for
-    #   example by pushing `ctx.spawn(tool, :thread)`,
-    #   `ctx.spawn(tool, :fiber)`, or `ctx.spawn(tool, :task)` onto {#queue}.
-    #   Mixed strategies can also be selected per tool, such as
-    #   `tool.mcp? ? ctx.spawn(tool, :task) : ctx.spawn(tool, :ractor)`.
-    #   Streamed tool resolution now prefers the current request tools, so
-    #   {LLM.function}, MCP tools, bound tool instances, and normal
-    #   {LLM::Tool LLM::Tool} classes can all resolve through the same
-    #   request-local path. The current `:ractor` mode is for class-based
-    #   tools and does not support MCP tools.
+    # A stream implementation may start tool execution here by pushing
+    # `@queue << tool.task(:thread)` onto {#queue}.
     # @param [LLM::Function] tool
     #  The parsed tool call.
     # @return [nil]
@@ -128,9 +138,8 @@ module LLM
 
     ##
     # Called when queued streamed tool work returns.
-    # @note This callback runs when {#wait} resolves work that was queued from
-    #   {#on_tool_call}, such as values returned by `ctx.spawn(tool, :thread)`,
-    #   `ctx.spawn(tool, :fiber)`, or `ctx.spawn(tool, :task)`.
+    # This callback runs when {#wait} resolves work queued from
+    # {#on_tool_call}.
     # @param [LLM::Function] tool
     #  The tool that returned.
     # @param [LLM::Function::Return] result
@@ -160,19 +169,17 @@ module LLM
 
     ##
     # Called before a context compaction starts.
-    # @param [LLM::Context] ctx
     # @param [LLM::Compactor] compactor
     # @return [nil]
-    def on_compaction(ctx, compactor)
+    def on_compaction(compactor)
       nil
     end
 
     ##
     # Called after a context compaction finishes.
-    # @param [LLM::Context] ctx
     # @param [LLM::Compactor] compactor
     # @return [nil]
-    def on_compaction_finish(ctx, compactor)
+    def on_compaction_finish(compactor)
       nil
     end
 

data/lib/llm/tool.rb

@@ -5,10 +5,23 @@
 # that can be called by an LLM. Under the hood, it is a wrapper
 # around {LLM::Function LLM::Function} but allows the definition
 # of a function (also known as a tool) as a class.
-# @example
-#   class System < LLM::Tool
-#     name "system"
-#     description "Runs system commands"
+#
+# @example Declarative form (preferred)
+#   class ReadFile < LLM::Tool
+#     name "read-file"
+#     description "Read a file from disk"
+#     parameter :path, String, "The filename or path"
+#     required %i[path]
+#
+#     def call(path:)
+#       {contents: File.read(path)}
+#     end
+#   end
+#
+# @example Block-form DSL (also supported)
+#   class RunCommand < LLM::Tool
+#     name "run-command"
+#     description "Runs a shell command"
 #     params do |schema|
 #       schema.object(command: schema.string.required)
 #     end
@@ -17,6 +30,9 @@
 #       {success: Kernel.system(command)}
 #     end
 #   end
+#
+# @see LLM::Agent Tools are attached to agents
+# @see LLM::Function The function object that Tool wraps
 class LLM::Tool
   require_relative "tool/param"
   extend LLM::Tool::Param

data/lib/llm/tools/chdir.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::Chdir LLM::Tool::Chdir} class implements

data/lib/llm/tools/git.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::Git LLM::Tool::Git} class implements
@@ -9,18 +7,24 @@ class LLM::Tool
   # The actions it can perform are read-only - at least for
   # the time being.
   class Git < self
+    require_relative "utils"
+    include Utils
+
     name "git"
     description "perform an action with git"
     parameter :action, Enum["log", "diff", "commit", "checkout", "branch", "show"], "the git operation to perform"
     parameter :arguments, Array[String], "one or more arguments for the git action"
+    parameter :timeout, Integer, "the maximum time to allow the command to run"
     required %i[action]
+    defaults arguments: [], timeout: 5
 
     ##
     # @param [String] action
     # @param [Array<String>, nil] arguments
     # @return [Hash]
-    def call(action:, arguments: nil)
+    def call(action:, arguments: [], timeout: 5)
       command = spawn(action:, arguments:)
+      wait(command:, timeout:)
       {ok: command.success?, stdout: command.stdout, stderr: command.stderr}
     end
 
@@ -34,7 +38,7 @@ class LLM::Tool
         .spawn
     end
 
-    LLM.require "test-cmd.rb"
+    LLM.require "test-cmd.rb",  "~> 1.1"
     Command = Test::Cmd
   end
 end

data/lib/llm/tools/mkdir.rb

@@ -26,7 +26,7 @@ class LLM::Tool
         .spawn
     end
 
-    LLM.require "test-cmd.rb"
+    LLM.require "test-cmd.rb", "~> 1.1"
     Command = Test::Cmd
   end
 end

data/lib/llm/tools/pwd.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::Pwd LLM::Tool::Pwd} class implements

data/lib/llm/tools/read_file.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::ReadFile LLM::Tool::ReadFile} class implements

data/lib/llm/tools/rg.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# frozen_string_literal
-
 class LLM::Tool
   ##
   # The {LLM::Tool::Rg LLM::Tool::Rg} class implements
@@ -9,19 +7,25 @@ class LLM::Tool
   # recursively search the current working directory
   # for one or more patterns.
   class Rg < self
+    require_relative "utils"
+    include Utils
+
     name "rg"
     description "recursively search the current directory for lines matching a pattern"
     parameter :patterns, Array[String], "one or more search patterns"
     parameter :path, String, "the path where the search is performed (default is cwd)"
+    parameter :timeout, Integer, "the number of seconds to wait before cancelling the action"
     required %i[patterns]
+    defaults path: Dir.getwd, timeout: 5
 
     ##
     # @param [Array<String>] patterns
     # @param [String] path
     # @return [Hash]
-    def call(patterns:, path: Dir.getwd)
+    def call(patterns:, path: Dir.getwd, timeout: 5)
       validate!(patterns:, path:)
       command = spawn(patterns:, path:)
+      wait(command:, timeout:)
       {ok: command.success?, stdout: command.stdout, stderr: command.stderr}
     end
 
@@ -41,7 +45,7 @@ class LLM::Tool
         .spawn
     end
 
-    LLM.require "test-cmd.rb"
+    LLM.require "test-cmd.rb", "~> 1.1"
     Command = Test::Cmd
   end
 end