active_prompt_rails 0.1.20 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d884aa97e92b98c307785818064cc0df6e65a4f290f000c9410f2203779dd75
-  data.tar.gz: d858cadc9db796cc036f148259c17eebdcb803b9288cea7506b3554de601279e
+  metadata.gz: b8ebc1137820c3403f5f5dd1e9f30566df779b5cfa512fdc02561a4b073515ca
+  data.tar.gz: 90f1bab204127f53a1ef82c284d9e086fb25ac39f2b08c07497dd0a596d1ce71
 SHA512:
-  metadata.gz: 8c38b600e5fcd89cabd640654e799d28ff9f529b607109843c7d40290c9a8c6e4b4ab908498b3e318cff62592493df4a38f38b0b7c5012b8e093dffbbba041c8
-  data.tar.gz: c1b6aa197e94d8acfb4cde43e4631855cbc3f458f7e9db35df4bf90d7d7bc12e2705d03c3a043e3ded0bf8f746d678777e147dfff514bb4bee1a0e329c8fe7a3
+  metadata.gz: eeca007dedff098f36cfb1e7e259c12952f45c9708968114c2556c1d13433c552711da1486ef2b0afb4b0109970624e3b5ba512da5868e140dd23b6d3d3a814f
+  data.tar.gz: bde818476db497761bf66b6f4dd2cebe639142d1e48f15ca2e9b15b3a88282147100acce30afaedc5c6f0d4c037a0c4e18f3753e9b461f176e1a48a790bf0910

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.1.22] - 2024-05-16
+
+- Added stub for `run()` method, which enables users to directly prompt the LLM by calling an ActivePrompt::Base object.
+
+- Added example code in comments for how one could implement an OpenAI LLM integration.
+
+## [0.1.21] - 2024-05-15
+
+- Fixed all bugs and prompts are now working. First release.
+
 ## [0.1.3] - 2024-05-15
 
 - Require all the lib files into the gem root file

data/README.md

@@ -7,7 +7,7 @@ ActivePrompt is a gem that helps you structure and manage LLM prompts in your ra
 Add the following line to your Gemfile:
 
 ```Gemfile
-gem "active_prompt_rails", "~> 0.1.20", require: "active_prompt"
+gem "active_prompt_rails", "~> 0.1.21", require: "active_prompt"
 ```
 
 and run `bundle install`

data/active_prompt.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Shane Perreault"]
   spec.email = ["shaneprrlt@gmail.com"]
   spec.summary = "Easily create and manage LLM prompt templates in your rails app."
-  spec.description = "Easily create and manage LLM prompt templates in your rails app." \
-                     "Use your own custom templating engine like ERB or Shopify Liquid."
+  spec.description = "Easily create and manage LLM prompt templates in your rails app."
   spec.homepage = "https://www.github.com/Shaneprrlt/active_prompt"
   spec.required_ruby_version = ">= 2.6.0"
   spec.metadata["homepage_uri"] = spec.homepage

data/lib/active_prompt/base.rb

@@ -40,6 +40,10 @@ module ActivePrompt
       ]
     end
 
+    def run
+      raise NotImplementedError, "Please implement this function using your chosen LLM library"
+    end
+
     private
 
     def render_template(template_name)

data/lib/active_prompt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActivePrompt
-  VERSION = "0.1.20"
+  VERSION = "0.1.22"
 end

data/lib/generators/active_prompt/prompt_generator.rb

@@ -9,18 +9,41 @@ module ActivePrompt
       desc "This generator creates a new prompt in the app/prompts directory"
       source_root File.expand_path("templates", __dir__)
 
+      # rubocop:disable Metrics/MethodLength
       def create_prompt_files
+        unless File.exist?("app/prompts/application_prompt.rb")
+          create_file "app/prompts/application_prompt.rb", <<~RUBY
+            # frozen_string_literal: true
+
+            class ApplicationPrompt < ActivePrompt::Base
+              def run(model: 'gpt-3.5-turbo-0613', json_output: false, temperature: 1.0)
+                # client = OpenAI::Client.new
+                # parameters = {
+                #   model: model,
+                #   messages: render_messages,
+                #   temperature: temperature
+                # }
+                # parameters[:response_format] = { type: 'json_object' } if json_output
+                # client.chat(parameters: parameters)
+
+                raise NotImplementedError, 'please implement this function using your chosen LLM library'
+              end
+            end
+          RUBY
+        end
+
         empty_directory "app/prompts/templates/#{name.underscore}_prompt"
         template "system.liquid", "app/prompts/templates/#{name.underscore}_prompt/system.liquid"
         template "user.liquid", "app/prompts/templates/#{name.underscore}_prompt/user.liquid"
         create_file "app/prompts/#{name.underscore}_prompt.rb", <<~RUBY
           # frozen_string_literal: true
 
-          class #{name.camelize}Prompt < ActivePrompt::Base
+          class #{name.camelize}Prompt < ApplicationPrompt
             # variable :name
           end
         RUBY
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_prompt_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.22
 platform: ruby
 authors:
 - Shane Perreault
@@ -50,8 +50,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description: Easily create and manage LLM prompt templates in your rails app.Use your
-  own custom templating engine like ERB or Shopify Liquid.
+description: Easily create and manage LLM prompt templates in your rails app.
 email:
 - shaneprrlt@gmail.com
 executables: []