llm_ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0de9e01920a472c7a04f9f794747090e3bf279b403d4efa206b1db7c2b006987
-  data.tar.gz: bd77b3a4c5540a82d4a6f1b93213a8b3da60cc9342e581335adeac6fe93c999f
+  metadata.gz: d377d13dd257a9b4a6def17668d3bb3badf4692f9e865faba142d5189d746519
+  data.tar.gz: a201962fb8dd4f245face648cc433e127afcc22832cb1499da89db2bc2816d7e
 SHA512:
-  metadata.gz: bc4b0263dfeaf1db4dded66667ea13e65dfc035d27579a2b032a59ae63f29fd588630d749d492d281322269fbc9d3909f8648f464d250baa99ff5b2afd582193
-  data.tar.gz: a4c5713df43e27127afa0b3cbf044ce8d805235f73abd05b3f79dc9fc7a814c193caac9192392a8670523cf74be96da2b52dc648d965116e8e9bbc3f8a2aaaaa
+  metadata.gz: 10a190d6b7f4aa364c17d91b383a744fd490b94437ba4779c973e1f9bdc65d92f16d03c075d807d2a6aaf9509cf837736a0c48860c6ebc9d7c3dea6fb41eacd4
+  data.tar.gz: a3e63a044316a257c1e429bf85882c86ff78d3af193a87a978e4552f3464cdb417c7ada8aaf35a3556672ea6e79196812dada4c25c2f9a624466981b195c2ad3

data/README.md

@@ -5,7 +5,6 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 
-
 LLMRuby is a Ruby gem that provides a consistent interface for interacting with multiple Large Language Model (LLM) APIs. Most OpenAI, Anthropic and Gemini models are currently supported.
 
 ## Installation
@@ -172,6 +171,26 @@ export ANTHROPIC_API_KEY=your_api_key_here
 export GEMINI_API_KEY=your_api_key_here
 ```
 
+## Structured Outputs
+
+OpenAI and Gemini models can be configured to generate responses that adhere to a provided schema. Even though each use a different format for configuring this schema, `llm_ruby` can handle the translation for you, so that you can share a single schema definition across models.
+
+```ruby
+
+llm = LLM.from_string!("gpt-4o")
+
+# Create a client
+client = llm.client
+
+# Send a chat message
+response_format = LLM::Schema.new("test_schema", {"type" => "object", "properties" => {"name" => {"type" => "string"}, "age" => {"type" => "integer"}}, "additionalProperties" => false, "required" => ["name", "age"]})
+# or load the schema from a file: LLM::Schema.from_file('myschema.json')
+response = client.chat([{role: :user, content: "Hello, world!"}], response_format: response_format)
+
+response.structured_output[:name] # Alex
+response.structured_output_object.name # Alex
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/llm.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require "zeitwerk"
+
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   "llm" => "LLM",
   "open_ai" => "OpenAI"
 )
+loader.ignore("#{__dir__}/llm_ruby.rb")
 loader.setup
 
 class LLM

data/lib/llm_ruby.rb

@@ -0,0 +1 @@
+require "llm"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llm_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alex Gamble
@@ -158,6 +158,7 @@ files:
 - lib/llm/schema.rb
 - lib/llm/stop_reason.rb
 - lib/llm/version.rb
+- lib/llm_ruby.rb
 homepage: https://github.com/agamble/llm_ruby
 licenses:
 - MIT