prompt_manager 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ae8d4c5f669935906248aa0e5ffc628e6ef0fbcc28eb31c889eb85b200d370
-  data.tar.gz: 44e51b38634667930b5524232cefd63fe0dab3ef334500714361680009186bfd
+  metadata.gz: 91badda19121014eee4d6c28b1cb882347d951af971d9afb021b00e558cb3fdc
+  data.tar.gz: 500c401e8ced2be25adacaf374a6e18e73c42ec811e7bb632155de9d5626370c
 SHA512:
-  metadata.gz: 634cc2d1cfdedaf1ca5f5a232334b7e8ccbad25dbb48e669daddf831e43eb45f03367f2921561cdb8ddcf1675ea48f1dcf8cc40defb479aa1eced3bb493442f9
-  data.tar.gz: f04cc92a7ac3c286fb3958eaa44358c402899a121e89ca41aa7bddd30c41bd704bed55dd57775340c622671d0fbf36eef48171ffc3d290f220d6306622486ef3
+  metadata.gz: 89c274000ee45ddb047eb33ab232d0e300fab51be512b1181e6d9d9dbf6abe5213013229bfd0450e948b78b09aa00aab882131ed066c7529e27c5865b8251647
+  data.tar.gz: 4fc94add6f43ab7b0f289849e68c3c6c9f35ca24a90983a459cd2ea9043de03b8b2f9ed6701a3a614be7efecd1fc5557ab0fb0d252e84dc628d38f9f80d2d9ba

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.4.1] = 2023-12-29
+- Changed @directives from Hash to an Array
+- Fixed keywords not being substituted in directives
+
 ## [0.4.0] = 2023-12-19
 - Add "//directives param(s)" with keywords just like the prompt text.
 

data/README.md

@@ -15,6 +15,10 @@ Manage the parameterized prompts (text) used in generative AI (aka chatGPT, Open
     - [Generative AI (gen-AI)](#generative-ai-gen-ai)
       - [What does a keyword look like?](#what-does-a-keyword-look-like)
       - [All about directives](#all-about-directives)
+        - [Example Prompt with Directives](#example-prompt-with-directives)
+        - [Accessing Directives](#accessing-directives)
+        - [Dynamic Directives](#dynamic-directives)
+        - [Executing Directives](#executing-directives)
       - [Comments Are Ignored](#comments-are-ignored)
   - [Storage Adapters](#storage-adapters)
     - [FileSystemAdapter](#filesystemadapter)
@@ -74,9 +78,11 @@ This is just the initial convention adopted by prompt_manager. It is intended th
 
 A directive is a line in the prompt text that starts with the two characters '//' - slash slash - just like in the old days of IBM JCL - Job Control Language.  A prompt can have zero or more directives.  Directives can have parameters and can make use of keywords.
 
-The `prompt_manager` only collections directives.  It extracts keywords from directive lines and provides the substitution of those keywords with other text just like it does for the prompt.  Remember a directive is part of the prompt.
+The `prompt_manager` only collects directives.  It extracts keywords from directive lines and provides the substitution of those keywords with other text just like it does for the prompt.  
 
-Here is an example problem with comments, directives and keywords:
+##### Example Prompt with Directives
+
+Here is an example prompt text file with comments, directives and keywords:
 
 ```
 # prompts/sing_a_song.txt
@@ -90,12 +96,14 @@ __END__
 Computers will never replace Frank Sinatra
 ```
 
+##### Accessing Directives
+
 Getting directives from a prompt is as easy as getting the kewyords:
 
 ```ruby
 prompt = PromptManager::Prompt.new(...)
 prompt.keywords   #=> an Array
-prompt.directives #=> a Hash
+prompt.directives #=> an Array of entries like: ['directive', 'parameters']
 
 # to_s builds the prompt by substituting
 # values for keywords amd removing comments.
@@ -104,9 +112,33 @@ prompt.directives #=> a Hash
 puts prompt.to_s  
 ```
 
-The Hash returned by the `prompt.directives` method has as its key the directive name (without the double-slash).  Its also case-sensitive.  So any typo made in editing the prompt with regard to the case of the directive's name will impact the backend processing of the prompt.
+The entries in the Array returned by the `prompt.directives` method is in the order that the directives were defined within the prompt.  Each entry has two elements:
+
+- directive name (without the // characters)
+- parameter string for the directive
+
+##### Dynamic Directives
+
+Since directies are collected after the keywords in the prompt have been substituted for their values, it is possible to have dynamically generated directives as part of a prompt.  For example:
+
+```
+//[COMMAND] [OPTIONS]
+# or
+[SOMETHING]
+```
+... where [COMMAND] gets replaced by some directive name.  [SOMETHING] could be replaced by "//directive options"
+
+##### Executing Directives
+
+The `prompt_manager` gem only collects directives.  Executing those directives is left up to some down stream process.  Here are some ideas on how directives could be used in prompt downstream process:
+
+- "//model gpt-5" could be used to set the LLM model to be used for a specific prompt.  
+- "//backend mods" could be used to set the backend prompt processor on the command line to be the `mods` utility.
+- "//include path_to_file" could be used to add the contents of a file to the prompt.
+- "//chat" could be used to send the prompts and then start up a chat session about the prompt and its response.
+
+Its all up to how your application wants to support directives or not.
 
-The value for each key is a String exactly as entered in the prompt file.
 
 #### Comments Are Ignored
 

data/lib/prompt_manager/prompt.rb

@@ -6,14 +6,17 @@
 # comment removal. It communicates with a storage system through a storage 
 # adapter.
 #
-# Directives can be anything required by the backend
-# prompt processing functionality.  Directives are
-# available along with the prompt text w/o comments.
-# Keywords can be used in the directives.
+# Directives are collected into an Array where each entry is an Array
+# of two elements.  The first is the directive name as a String. The 
+# second is a string of parameters used by the directive.
+# 
+# Directives are collected from the prompt after keyword
+# substitution has occured.  This means that directives within a
+# prompt can be dynamic.
 #
-# It is expected that the backend prompt processes will
-# act on and remove the directives before passing the
-# prompt text on through the LLM.
+# PromptManager does not execute directives.  They
+# are made available to be passed on to down stream
+# process.
 
 class PromptManager::Prompt
   COMMENT_SIGNAL    = '#'   # lines beginning with this are a comment
@@ -58,7 +61,7 @@ class PromptManager::Prompt
   
   # SMELL:  Does the db (aka storage adapter) really need
   #         to be accessible by the main program?
-  attr_accessor :db, :id, :text, :parameters
+  attr_accessor :db, :id, :text, :parameters, :directives
 
 
   # Retrieve the specific prompt ID from the Storage system.
@@ -76,10 +79,9 @@ class PromptManager::Prompt
     @text       = @record[:text]
     @parameters = @record[:parameters]
     @keywords   = []  # Array of String
-    @directives = {}  # Hash with directive as key, parameters as value
+    @directives = []  # Array of arrays. directive is first entry, rest are parameters
 
     update_keywords
-    update_directives
 
     build
   end
@@ -125,7 +127,8 @@ class PromptManager::Prompt
                 param_name = match
                 Array(parameters[param_name]).last || match
               end
-
+              
+    save_directives(@prompt)
     remove_comments
   end
 
@@ -135,11 +138,6 @@ class PromptManager::Prompt
   end
 
 
-  def directives
-    update_directives    
-  end
-
-
   ######################################
   private
 
@@ -153,14 +151,16 @@ class PromptManager::Prompt
   end
 
 
-  def update_directives
-    @text.split("\n").each do |a_line|
+  def save_directives(keyword_substituted_string)
+    @directives = []
+
+    keyword_substituted_string.split("\n").each do |a_line|
       line = a_line.strip
       next unless line.start_with?(DIRECTIVE_SIGNAL)
       
-      parts     = line.split(' ')
-      directive = parts.shift()[DIRECTIVE_SIGNAL.length..] # drop the directive signal
-      @directives[directive] = parts.join(' ')
+      parts       = line.split(' ')
+      directive   = parts.shift[DIRECTIVE_SIGNAL.length..] # drop the directive signal
+      @directives << [directive, parts.join(' ')]
     end
 
     @directives
@@ -171,7 +171,8 @@ class PromptManager::Prompt
     lines           = @prompt
                         .split("\n")
                         .reject{|a_line| 
-                          a_line.strip.start_with?(COMMENT_SIGNAL)
+                          a_line.strip.start_with?(COMMENT_SIGNAL)  ||
+                          a_line.strip.start_with?(DIRECTIVE_SIGNAL)
                         }
 
     # Remove empty lines at the start of the prompt

data/lib/prompt_manager/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prompt_manager
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Manage prompts for use with gen-AI processes