ai-chat 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21d17972572c7c6282aa2a40c539f48967b47caad6ac0f80f99046337436576
-  data.tar.gz: b27033cec74910347d8f965e7aa4928b888a0d42aa8f14c48bc229014522cf7d
+  metadata.gz: 4dd73c65bb0fa8183801233a76038c8e9a32f86268ab113311317a47f72504db
+  data.tar.gz: 8a6541039268eee87a035f7547d767919962b8f20573e06618700e05ea72ffe6
 SHA512:
-  metadata.gz: 5fd677c3e077c29a9777c1c1fa57108798d39ad09fed0093db12ce0819c9a4a204bbc8cbbfd84b4236df48b9ee7e3a0ea0469d29745188d1a22d3f5789f5c65a
-  data.tar.gz: 4edb6917f52330c5a8dd27e825e1cc27201da82ab8cc7e4988d0514b3ed92969f0b8369be4ceec44fbaa3684545774060430ca110730e5dfe753686c4f292526
+  metadata.gz: b2564b32f5f1c69e8749eb079339d120cbfbf71ce9c5870cfb7b47ea81891ec11dbc9290b59f2b49b35830f59d7f0817d3dcaa558bc5ef1d97309a0a26da3733
+  data.tar.gz: ae9ebf5fd4b0a1001e6fb047585c852055c43cfc2b7af7fc3385ed8df355aec260e2ba6e80a2443b9104648a49356124974353317d3818449413fe923ab27a0a

data/README.md

@@ -362,6 +362,40 @@ i.schema = '{"name":"nutrition_values","strict":true,"schema":{...}}'
 i.schema = '{"type":"object","properties":{...}}'
 ```
 
+### Generating a Schema
+
+You can call the class method `AI::Chat.generate_schema!` to use OpenAI to generate a JSON schema for you given a `String` describing the schema you want.
+
+```rb
+AI::Chat.generate_schema!("A user profile with name (required), email (required), age (number), and bio (optional text).")
+# => "{ ... }"
+```
+
+This method returns a String containing the JSON schema. The JSON schema also writes (or overwrites) to `schema.json` at the root of the project.
+
+Similar to generating messages with `AI::Chat` objects, this class method will assume that you have an API key called `OPENAI_API_KEY` defined. You can also pass the API key directly or choose a different environment variable key for it to use.
+
+```rb
+# Passing the API key directly
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", api_key: "MY_SECRET_API_KEY")
+
+# Choosing a different API key name
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", api_key_env_var: "CUSTOM_KEY")
+```
+
+You can choose a location for the schema to save by using the `location` keyword argument.
+
+```rb
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", location: "my_schemas/user.json")
+```
+
+If you don't want to write the output to a file, you can pass `false` to `location`.
+
+```rb
+AI::Chat.generate_schema!("A user with full name (required), first_name (required), and last_name (required).", location: false)
+# => { ... }
+```
+
 ### Schema Notes
 
 - The keys can be `String`s or `Symbol`s.

data/ai-chat.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "ai-chat"
-  spec.version = "0.3.0"
+  spec.version = "0.3.2"
   spec.authors = ["Raghu Betina"]
   spec.email = ["raghu@firstdraft.com"]
   spec.homepage = "https://github.com/firstdraft/ai-chat"

data/lib/ai/chat.rb

@@ -23,7 +23,7 @@ module AI
   class Chat
     # :reek:Attribute
     attr_accessor :background, :code_interpreter, :conversation_id, :image_generation, :image_folder, :messages, :model, :proxy, :previous_response_id, :web_search
-    attr_reader :reasoning_effort, :client, :schema
+    attr_reader :reasoning_effort, :client, :schema, :schema_file
 
     VALID_REASONING_EFFORTS = [:low, :medium, :high].freeze
     PROXY_URL = "https://prepend.me/".freeze
@@ -40,15 +40,15 @@ module AI
       @image_folder = "./images"
     end
 
-    def self.generate_schema!(description, api_key: nil, api_key_env_var: "OPENAI_API_KEY", proxy: false)
-      @api_key ||= ENV.fetch(api_key_env_var)
+    def self.generate_schema!(description, location: "schema.json", api_key: nil, api_key_env_var: "OPENAI_API_KEY", proxy: false)
+      api_key ||= ENV.fetch(api_key_env_var)
       prompt_path = File.expand_path("../prompts/schema_generator.md", __dir__)
       system_prompt = File.open(prompt_path).read
 
       json = if proxy
         uri = URI(PROXY_URL + "api.openai.com/v1/responses")
         parameters = {
-          model: "o4-mini",
+          model: "gpt-5.1",
           input: [
             {role: :system, content: system_prompt},
             {role: :user, content: description},
@@ -61,7 +61,7 @@ module AI
       else
         client = OpenAI::Client.new(api_key: api_key)
         response = client.responses.create(
-          model: "o4-mini",
+          model: "gpt-5.1",
           input: [
             {role: :system, content: system_prompt},
             {role: :user, content: description}
@@ -73,7 +73,15 @@ module AI
         output_text = response.output_text
         JSON.parse(output_text)
       end
-      JSON.pretty_generate(json)
+      content = JSON.pretty_generate(json)
+      if location
+        path = Pathname.new(location)
+        FileUtils.mkdir_p(path.dirname) if path.dirname != "."
+        File.open(location, "wb") do |file|
+          file.write(content)
+        end
+      end
+      content
     end
 
     # :reek:TooManyStatements
@@ -192,6 +200,12 @@ module AI
       end
     end
 
+    def schema_file=(path)
+      content = File.open(path).read
+      @schema_file = path
+      self.schema = content
+    end
+
     def last
       messages.last
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ai-chat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Raghu Betina
 bindir: bin
 cert_chain: []
-date: 2025-11-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openai
@@ -146,8 +146,8 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - LICENSE
 - README.md
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A beginner-friendly Ruby interface for OpenAI's API
 test_files: []