llm.rb 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46af7f9487355b1ad33501bdc2602f2bfbb9ac3a7a3377eb601d367167373b69
-  data.tar.gz: f1bb4dc1b423e5335d19540c664af714d523ecded97476fb379711f2015fa93a
+  metadata.gz: 2ae98573410bfc74a61f0bf15f811c30800b6567c9e5fc9e4cbe50f4994a200f
+  data.tar.gz: 9776839912017f5f3bac8452670c60b3bc9eabecebe11c402458a36b78d958e7
 SHA512:
-  metadata.gz: b249df823bedda3041df65b4f17b861d7529737855c2395dbcb978838098eecb0950ec935e06f290d9737f7b780c64a42cd21bf54e8077360947c1e70c3bad04
-  data.tar.gz: 0a35370e5cd41488dfcbc05259c28ac906e1a3b217f4882aebfb87a8ee5b9d04ca771df9ed77d32efc0782510bc35c33db7a0704a81841ae1b8f9d832d5f3af7
+  metadata.gz: 4252d2d861d409428067415340c2d36f2e75f34f3be9905a576a63455902d1faf4100d8c8c7060e683fe922ff095cc00fd56fd135b9589a746d9de716c66e5e5
+  data.tar.gz: 819676961e401aa5e27678e3d36af406362f0a68b0243e1e1f71f5f135286830dd1c009c47c69c26b6789a771da6a1fe72eb023f0f1833c20ffadac37f58ed1b

data/README.md

@@ -133,7 +133,7 @@ The interface is designed so you could drop in any other library in its place:
 require "llm"
 
 llm = LLM.openai(ENV["KEY"])
-schema = llm.schema.object({os: llm.schema.string.enum("OpenBSD", "FreeBSD", "NetBSD").required})
+schema = llm.schema.object({os: llm.schema.string.enum("OpenBSD", "FreeBSD", "NetBSD")})
 bot = LLM::Chat.new(llm, schema:)
 bot.chat "You secretly love NetBSD", :system
 bot.chat "What operating system is the best?", :user
@@ -364,7 +364,7 @@ bot.messages.select(&:assistant?).each { print "[#{_1.role}] ", _1.content, "\n"
 Generally all providers accept text prompts but some providers can
 also understand URLs, and various file types (eg images, audio, video,
 etc). The llm.rb approach to multimodal prompts is to let you pass `URI`
-objects to describe links, `LLM::File` / `LLM::Response::File` objects
+objects to describe links, `LLM::File` | `LLM::Response::File` objects
 to describe files, `String` objects to describe text blobs, or an array
 of the aforementioned objects to describe multiple objects in a single
 prompt. Each object is a first class citizen that can be passed directly
@@ -372,9 +372,7 @@ to a prompt.
 
 For more depth and examples on how to use the multimodal API, please see
 the [provider-specific documentation](https://0x1eef.github.io/x/llm.rb/)
-for more provider-specific examples – there can be subtle differences
-between providers and even between APIs from the same provider that are
-not covered in the README:
+for more provider-specific examples:
 
 ```ruby
 #!/usr/bin/env ruby

data/lib/json/schema/array.rb

@@ -2,9 +2,8 @@
 
 class JSON::Schema
   class Array < Leaf
-    def initialize(items, **rest)
+    def initialize(*items)
       @items = items
-      super(**rest)
     end
 
     def to_h

data/lib/json/schema/leaf.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 class JSON::Schema
+  ##
+  # The {JSON::Schema::Leaf JSON::Schema::Leaf} class is the
+  # superclass of all values that can appear in a JSON schema.
+  # See the instance methods of {JSON::Schema JSON::Schema} for
+  # an example of how to create instances of {JSON::Schema::Leaf JSON::Schema::Leaf}
+  # through its subclasses.
   class Leaf
     def initialize
       @description = nil
@@ -9,30 +15,51 @@ class JSON::Schema
       @required = nil
     end
 
+    ##
+    # Set the description of a leaf
+    # @param [String] str The description
+    # @return [JSON::Schema::Leaf]
     def description(str)
       tap { @description = str }
     end
 
+    ##
+    # Set the default value of a leaf
+    # @param [Object] value The default value
+    # @return [JSON::Schema::Leaf]
     def default(value)
       tap { @default = value }
     end
 
+    ##
+    # Set the allowed values of a leaf
+    # @param [Array] values The allowed values
+    # @return [JSON::Schema::Leaf]
     def enum(*values)
       tap { @enum = values }
     end
 
+    ##
+    # Denote a leaf as required
+    # @return [JSON::Schema::Leaf]
     def required
       tap { @required = true }
     end
 
+    ##
+    # @return [Hash]
     def to_h
       {description: @description, default: @default, enum: @enum}.compact
     end
 
+    ##
+    # @return [String]
     def to_json(options = {})
       to_h.to_json(options)
     end
 
+    ##
+    # @return [Boolean]
     def required?
       @required
     end

data/lib/json/schema/version.rb

@@ -0,0 +1,6 @@
+module JSON
+end unless defined?(JSON)
+
+class JSON::Schema
+  VERSION = "0.1.0"
+end

data/lib/json/schema.rb

@@ -3,7 +3,25 @@
 module JSON
 end unless defined?(JSON)
 
+##
+# The {JSON::Schema JSON::Schema} class represents a JSON schema,
+# and provides methods that let you describe and produce a schema
+# that can be used in various contexts that include the validation
+# and generation of JSON data.
+#
+# @see https://json-schema.org/ JSON Schema Specification
+# @see https://tour.json-schema.org/ JSON Schema Tour
+#
+# @example
+#  schema = JSON::Schema.new
+#  schema.object({
+#    name: schema.string.enum("John", "Jane").required,
+#    age: schema.integer.required,
+#    hobbies: schema.array(schema.string, schema.null).required,
+#    address: schema.object({street: schema.string}).required,
+#  })
 class JSON::Schema
+  require_relative "schema/version"
   require_relative "schema/leaf"
   require_relative "schema/object"
   require_relative "schema/array"
@@ -15,25 +33,22 @@ class JSON::Schema
 
   ##
   # Returns an object
-  # @param properties [Hash] A hash of properties
-  # @param rest [Hash] Any other options
+  # @param [Hash] properties A hash of properties
   # @return [JSON::Schema::Object]
-  def object(properties, **rest)
-    Object.new(properties, **rest)
+  def object(properties)
+    Object.new(properties)
   end
 
   ##
   # Returns an array
-  # @param items [Array] An array of items
-  # @param rest [Hash] Any other options
+  # @param [Array] items An array of items
   # @return [JSON::Schema::Array]
-  def array(items, **rest)
-    Array.new(items, **rest)
+  def array(*items)
+    Array.new(*items)
   end
 
   ##
   # Returns a string
-  # @param rest [Hash] Any other options
   # @return [JSON::Schema::String]
   def string(...)
     String.new(...)
@@ -41,7 +56,6 @@ class JSON::Schema
 
   ##
   # Returns a number
-  # @param rest [Hash] Any other options
   # @return [JSON::Schema::Number] a number
   def number(...)
     Number.new(...)
@@ -49,7 +63,6 @@ class JSON::Schema
 
   ##
   # Returns an integer
-  # @param rest [Hash] Any other options
   # @return [JSON::Schema::Integer]
   def integer(...)
     Integer.new(...)
@@ -57,7 +70,6 @@ class JSON::Schema
 
   ##
   # Returns a boolean
-  # @param rest [Hash] Any other options
   # @return [JSON::Schema::Boolean]
   def boolean(...)
     Boolean.new(...)
@@ -65,7 +77,6 @@ class JSON::Schema
 
   ##
   # Returns null
-  # @param rest [Hash] Any other options
   # @return [JSON::Schema::Null]
   def null(...)
     Null.new(...)

data/lib/llm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Antar Azri
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-29 00:00:00.000000000 Z
+date: 2025-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -158,6 +158,7 @@ files:
 - lib/json/schema/number.rb
 - lib/json/schema/object.rb
 - lib/json/schema/string.rb
+- lib/json/schema/version.rb
 - lib/llm.rb
 - lib/llm/buffer.rb
 - lib/llm/chat.rb