llm.rb 0.9.1 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20812e4c8cfc7ebee81190054e7483b00b24e0f0f567f630bfb4dc0ac962193f
-  data.tar.gz: 4ff26fa74520b29da3b6aa10331d5cd618e13d4df53cb9f0c5b7a7691f5fb42e
+  metadata.gz: 39e538d8185cf5c8c5a36da0e1bf5b0b9e0055945a02570cd00fefc805b288d0
+  data.tar.gz: 7fc0d3a4422fe10bb3058c7b1b5b9bc80693ccc0dbf6b62bda46d42fb7c2830c
 SHA512:
-  metadata.gz: 4ed6e3f0426fc0967cb59cc14ae0d0afe552a93e2a29b8d173bf000341b77800ea31ef9088d45a696d353ac0e7f58cc1b3d7f86c3c15d757ae73efb33523b56d
-  data.tar.gz: 136e14863ef92264e270f3b6616a9660298cdc477a2a15db1b89b9360be1ce2be3dde0ee66d97be68d57c5bf68f4f0fc9764657187fbf2ae226f1a5ed6579189
+  metadata.gz: a2b3de69ce317d856ec593074e22883ec2b96ddcdc2637cb2b4c555885c1c771b2ffd447b255cdc16a2c7f1c2b72362ab1b6e29ec0fdf775e977292b03fd3e34
+  data.tar.gz: c2ba0f853b7eaac4ca8fab15f497a3fa375e054b7da928b2f0798e393909baff20d2381afd48e793fd878261a0d838474e4be3be5b5232e480cf162af57dbe2e

data/README.md

@@ -30,19 +30,20 @@ images, files, and JSON Schema generation.
 
 ## Demos
 
-<details>
-  <summary><b>1. Tools: "system" function</b></summary>
-  <img src="https://github.com/llmrb/llm/raw/main/share/llm-shell/examples/toolcalls.gif">
-</details>
+> The
+> [llmrb/llm-shell](https://github.com/llmrb/llm-shell)
+> project is built with llm.rb and its demos have been
+> included to provide a better idea of what llm.rb
+> is capable of.
 
 <details>
-  <summary><b>2. Files: import at runtime</b></summary>
-  <img src="https://github.com/llmrb/llm/raw/main/share/llm-shell/examples/files-runtime.gif">
+  <summary><b>1. An introduction to tool calls</b></summary>
+  <img src="https://github.com/llmrb/llm/raw/main/share/llm-shell/examples/toolcalls_v2.gif">
 </details>
 
 <details>
-  <summary><b>3. Files: import at boot time</b></summary>
-  <img src="https://github.com/llmrb/llm/raw/main/share/llm-shell/examples/files-boottime.gif">
+  <summary><b>2. Add files as conversation context</b></summary>
+  <img src="https://github.com/llmrb/llm/raw/main/share/llm-shell/examples/files-runtime_v2.gif">
 </details>
 
 ## Examples
@@ -114,13 +115,13 @@ msgs.each { print "[#{_1.role}] ", _1.content, "\n" }
 > There Is More Than One Way To Do It (TIMTOWTDI) when you are
 > using llm.rb &ndash; and this is especially true when it
 > comes to streaming. See the streaming documentation in
-> [docs/](docs/STREAMING.md#flexibility) for more details.
+> [docs/](docs/STREAMING.md#scopes) for more details.
 
 The following example streams the messages in a conversation
 as they are generated in real-time. This feature can be useful
-in case you want to see the contents of a message as it is
-generated, or in case you want to avoid potential read timeouts
-during the generation of a response.
+when you want to stream a conversation in real time, or when you
+want to avoid potential read timeouts during the generation of a
+response.
 
 The `stream` option can be set to an IO object, or the value `true`
 to enable streaming &ndash; and at the end of the request, `bot.chat`
@@ -496,22 +497,10 @@ else there's the API reference. It covers classes and methods that the README gl
 over or doesn't cover at all. The API reference is available at
 [0x1eef.github.io/x/llm.rb](https://0x1eef.github.io/x/llm.rb).
 
-
 ### Guides
 
 The [docs/](docs/) directory contains some additional documentation that
-didn't quite make it into the README. It covers the design guidelines that
-the library follows, some strategies for memory management, and other
-provider-specific features.
-
-## See also
-
-**[llmrb/llm-shell](https://github.com/llmrb/llm-shell)**
-
-An extensible, developer-oriented command line utility that is powered by
-llm.rb and serves as a demonstration of the library's capabilities. The
-[demo](https://github.com/llmrb/llm-shell#demos) section has a number of GIF
-previews might be especially interesting.
+didn't quite make it into the README.
 
 ## Install
 

data/lib/llm/buffer.rb

@@ -2,7 +2,6 @@
 
 module LLM
   ##
-  # @private
   # {LLM::Buffer LLM::Buffer} provides an Enumerable object that
   # yields each message in a conversation on-demand, and only sends
   # a request to the LLM when a response is needed.
@@ -58,6 +57,15 @@ module LLM
     end
     alias_method :push, :<<
 
+    ##
+    # @param [Integer, #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]
+    end
+
     ##
     # @return [String]
     def inspect

data/lib/llm/function.rb

@@ -33,6 +33,11 @@ class LLM::Function
   class Return < Struct.new(:id, :value)
   end
 
+  ##
+  # Returns the function ID
+  # @return [String, nil]
+  attr_accessor :id
+
   ##
   # Returns the function name
   # @return [String]
@@ -43,11 +48,6 @@ class LLM::Function
   # @return [Array, nil]
   attr_accessor :arguments
 
-  ##
-  # Returns the function ID
-  # @return [String, nil]
-  attr_accessor :id
-
   ##
   # @param [String] name The function name
   # @yieldparam [LLM::Function] self The function object
@@ -61,10 +61,14 @@ class LLM::Function
 
   ##
   # Set the function description
-  # @param [String] str The function description
+  # @param [String] desc The function description
   # @return [void]
-  def description(str)
-    @description = str
+  def description(desc = nil)
+    if desc
+      @description = desc
+    else
+      @description
+    end
   end
 
   ##

data/lib/llm/providers/anthropic.rb

@@ -76,10 +76,10 @@ module LLM
 
     ##
     # Returns the default model for chat completions
-    # @see https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-comparison-table claude-3-5-sonnet-20240620
+    # @see https://docs.anthropic.com/en/docs/about-claude/models/all-models#model-comparison-table claude-sonnet-4-20250514
     # @return [String]
     def default_model
-      "claude-3-5-sonnet-20240620"
+      "claude-sonnet-4-20250514"
     end
 
     private

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

@@ -43,7 +43,7 @@ class LLM::Gemini
     def create(prompt:, model: "gemini-2.0-flash-exp-image-generation", **params)
       req  = Net::HTTP::Post.new("/v1beta/models/#{model}:generateContent?key=#{key}", headers)
       body = JSON.dump({
-        contents: [{parts: {text: prompt}}],
+        contents: [{parts: [{text: create_prompt}, {text: prompt}]}],
         generationConfig: {responseModalities: ["TEXT", "IMAGE"]}
       }.merge!(params))
       req.body = body
@@ -93,6 +93,15 @@ class LLM::Gemini
       @provider.instance_variable_get(:@key)
     end
 
+    def create_prompt
+      <<~PROMPT
+        Your task is to generate one or more image(s) from
+        text I will provide to you. Your response *MUST* include
+        at least one image, and your response *MUST NOT* include
+        any text or other content.
+      PROMPT
+    end
+
     [:response_parser, :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.rb

@@ -126,10 +126,10 @@ module LLM
 
     ##
     # Returns the default model for chat completions
-    # @see https://ai.google.dev/gemini-api/docs/models#gemini-1.5-flash gemini-1.5-flash
+    # @see https://ai.google.dev/gemini-api/docs/models#gemini-2.5-flash gemini-2.5-flash
     # @return [String]
     def default_model
-      "gemini-1.5-flash"
+      "gemini-2.5-flash"
     end
 
     private

data/lib/llm/providers/openai.rb

@@ -121,10 +121,10 @@ module LLM
 
     ##
     # Returns the default model for chat completions
-    # @see https://platform.openai.com/docs/models/gpt-4o-mini gpt-4o-mini
+    # @see https://platform.openai.com/docs/models/gpt-4.1 gpt-4.1
     # @return [String]
     def default_model
-      "gpt-4o-mini"
+      "gpt-4.1"
     end
 
     private

data/lib/llm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.1
 platform: ruby
 authors:
 - Antar Azri
@@ -282,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.7.1
 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