active_prompt_rails 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cce75514b94749199f3bd2b3dbbb3a5017ae5bd69d2c32af838a4aa84268a2c
-  data.tar.gz: 6fc57f049084c4e4f804c606eb9e9b1f482d06cad1ff48e203f8c517863c1b58
+  metadata.gz: d9b0ed834ff87bf6e5e43d1a513cebece5021afc6b4306dda7c4bd7b89038066
+  data.tar.gz: 5febc8f1d53ef6309da8d579c78c58bd6ab5b302f7dd1304e999005dd5e89caa
 SHA512:
-  metadata.gz: 9dfbb0943bab181f662da38f69b92a2141f8599743d4e14ad6870cef3d9218c2d35c5a9335ec473085e05d3896eb10365766e46b5bffe122c8c4900c4bea8c41
-  data.tar.gz: 72e5e29a24e415e5b467464fe0b44d35c7bd8398e76db307159aa00575f2703cd33cfe4e1875719769fae6ff75d0ad9387d32049b4435a5a8bce391d8c345552
+  metadata.gz: f3b645c825c321dad775b564d1e2d7001b66fd8c94114f10dd1570ea3498f9e03af62b42f6009f9b73f7b4dad59cc8e457b7c4e238d7a5135dd631c480c4be4a
+  data.tar.gz: d4d0f0a9b498f3ff84ecb65e79a5ef3a8f2f3b674fff8b722c7b9442985c8aa715294e70454d9a420d59fd2fed0ef1efd4b7787e01c5d5236b502c58e61ca537

data/README.md

@@ -1,24 +1,79 @@
 # ActivePrompt
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_prompt`. To experiment with that code, run `bin/console` for an interactive prompt.
+ActivePrompt is a gem that helps you structure and manage LLM prompts in your rails apps.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add the following line to your Gemfile:
+
+```Gemfile
+gem "active_prompt_rails", "~> 0.1.18", require: "active_prompt"
+```
 
-Install the gem and add to the application's Gemfile by executing:
+and run `bundle install`
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+When you want to create a new LLM prompt, you can generate one using the following command:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+rails g active_prompt:prompt moderate_user_comment
+```
 
-## Usage
+This will create the following files in your rails project:
+
+```bash
+app/prompts/moderate_user_comment_prompt.rb
+app/prompts/templates/moderate_user_comment_prompt/system.liquid
+app/prompts/templates/moderate_user_comment_prompt/user.liquid
+```
+
+You can add your system message and user message to the corresponding Liquid template files and include any dynamic variables you'd like, e.g.:
+
+```ruby
+# /app/prompts/moderate_user_comment_prompt.rb
+
+class ModerateUserCommentPrompt < ActivePrompt::Base
+  variable :comment
+end
+```
+
+```liquid
+# /app/prompts/templates/moderate_user_comment_prompt/system.liquid
+
+You are a comment moderator agent that is responsible for reviewing and moderating user comments on a social media platform. You are assigned to reviewing comments and returning your decision on whether to approve or flag them for further review. Check for bullying, hate speech, and threatening language. Swearing is allowed as long as it's not harrassing. You return your decision in JSON format with the following structure: 
+{
+  "result": "approve" (or "flag"),
+  "reason": "optional reason for flagging the comment"
+}
+```
+
+```liquid
+# /app/prompts/templates/moderate_user_comment_prompt/user.liquid
+
+Review this comment and return your decision in the specified JSON format:
+
+{{ comment }}
+```
+
+Then within your application, you can use this prompt when calling an LLM as such:
+
+```ruby
+prompt = ModerateUserCommentPrompt.new(comment: user_comment)
 
-TODO: Write usage instructions here
+client = OpenAI::Client.new
+response = client.chat(
+    parameters: {
+        model: "gpt-4o",
+        response_format: { type: "json_object" },
+        messages: prompt.render_messages, # ActivePrompt::Base.render_messages returns OpenAI formatted message data
+        temperature: 1.0
+    }
+)
+content = response.dig("choices", 0, "message", "content")
+data = JSON.parse(content)
+puts data
+```
 
 ## Development
 
@@ -28,4 +83,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_prompt.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shaneprrlt/active_prompt.

data/lib/active_prompt/version.rb

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

data/lib/generators/active_prompt/prompt_generator.rb

@@ -14,12 +14,10 @@ module ActivePrompt
         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
-          # This is a generated prompt class for #{file_name}
+          # frozen_string_literal: true
+
           class #{name.camelize}Prompt < ActivePrompt::Base
-            # Define your required template variables here, e.g.
             # variable :name
-            # variable :age
-            # variable :gender
           end
         RUBY
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_prompt_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Shane Perreault