spectre_ai 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf3f5f31178a8456ccbb32bf9d68560efa5873751d3b3ca95c71921734b5da0
-  data.tar.gz: 9e96ac4a9eb3bb69dca886cff6570450f6380100c6df2df789f1c0bc0b7327f6
+  metadata.gz: c7c3acf59b77ad62e0095fb7f91aa0491a50f25d197f94c788ad5ce2bbefbf6f
+  data.tar.gz: 48b4a9dcda9a013a6dde32ca5008a7dd33a49f4d4678952b8fcbf2089d2ccca6
 SHA512:
-  metadata.gz: 23dc62f85aa5d69faa16036349560dcf0a97f214f636598387921ba4fa63b48863a69db2e60518d05aeae383a1b27ba8a82ff03bf40ec9fa46b5c7fa059ce546
-  data.tar.gz: 12203cbdfc16fb9e4983362eee4a700f33ba220516ad75663f0bfafc57a2b503c164fb7e7efc90913f3cbb73c6f62d589c9a39b4fdeda0e22fa1decbfc14732c
+  metadata.gz: be7bf9f1570bad924509a8b8ad2a4671d019d20325696c4a2587e586f4a9314e395d822857cf9a277c84fd69e1d61e1231b356405266b5147187d6ec01d7dd33
+  data.tar.gz: f80dddebe6a99f7c946a8364f62f15112a974ad6cffe5a031baf5c1a9b151f39c12b870c60945277b8c57e78e51a0f0bb7147c620af11e4a59ed1ce485bfebab

data/CHANGELOG.md

@@ -66,4 +66,18 @@ Code Refactoring:
 
 **Documentation:** Updated class-level documentation and method comments for better clarity and understanding of the class’s functionality and usage.
 
-This version enhances the flexibility and robustness of the Completions class, enabling more complex interactions and better error handling for different types of API responses.
+This version enhances the flexibility and robustness of the Completions class, enabling more complex interactions and better error handling for different types of API responses.
+
+# Changelog for Version 1.1.1
+
+**Release Date:** [11th Oct 2024]
+
+**New Features:**
+
+* **Nested Template Support in Prompts**
+  * You can now organize your prompt files in nested directories and render them using the `Spectre::Prompt.render` method.
+  * **Example**: To render a template from a nested folder:
+    ```ruby
+    Spectre::Prompt.render(template: 'classification/intent/user', locals: { query: 'What is AI?' })
+    ```
+  * This feature allows for better organization and scalability when dealing with multiple prompt categories and complex scenarios.

data/README.md

@@ -377,6 +377,37 @@ Spectre::Prompt.render(
 - **`template`:** The path to the prompt template file (e.g., `rag/system`).
 - **`locals`:** A hash of variables to be used inside the ERB template.
 
+**Using Nested Templates for Prompts**
+
+Spectre's `Prompt` class now supports rendering templates from nested directories. This allows you to better organize your prompt files in a structured folder hierarchy.
+
+You can organize your prompt templates in subfolders. For instance, you can have the following structure:
+
+```
+app/
+  spectre/
+    prompts/
+      rag/
+        system.yml.erb
+        user.yml.erb
+      classification/
+        intent/
+          system.yml.erb
+          user.yml.erb
+        entity/
+          system.yml.erb
+          user.yml.erb
+```
+
+To render a prompt from a nested folder, simply pass the full path to the `template` argument:
+
+```ruby
+# Rendering from a nested folder
+Spectre::Prompt.render(template: 'classification/intent/user', locals: { query: 'What is AI?' })
+```
+
+This allows for more flexibility when organizing your prompt files, particularly when dealing with complex scenarios or multiple prompt categories.
+
 **Combining Completions with Prompts**
 
 You can also combine completions and prompts like so:

data/lib/spectre/prompt.rb

@@ -5,107 +5,119 @@ require 'yaml'
 
 module Spectre
   class Prompt
-    PROMPTS_PATH = File.join(Dir.pwd, 'app', 'spectre', 'prompts')
-
-    # Render a prompt by reading and rendering the YAML template
-    #
-    # @param template [String] The path to the template file, formatted as 'type/prompt' (e.g., 'rag/system')
-    # @param locals [Hash] Variables to be passed to the template for rendering
-    #
-    # @return [String] Rendered prompt
-    def self.render(template:, locals: {})
-      type, prompt = split_template(template)
-      file_path = prompt_file_path(type, prompt)
-
-      raise "Prompt file not found: #{file_path}" unless File.exist?(file_path)
-
-      # Preprocess the locals before rendering the YAML file
-      preprocessed_locals = preprocess_locals(locals)
-
-      template_content = File.read(file_path)
-      erb_template = ERB.new(template_content)
-
-      context = Context.new(preprocessed_locals)
-      rendered_prompt = erb_template.result(context.get_binding)
-
-      # YAML.safe_load returns a hash, so fetch the correct part based on the prompt
-      parsed_yaml = YAML.safe_load(rendered_prompt)[prompt]
-
-      # Convert special characters back after YAML processing
-      convert_special_chars_back(parsed_yaml)
-    rescue Errno::ENOENT
-      raise "Template file not found at path: #{file_path}"
-    rescue Psych::SyntaxError => e
-      raise "YAML Syntax Error in file #{file_path}: #{e.message}"
-    rescue StandardError => e
-      raise "Error rendering prompt for template '#{template}': #{e.message}"
-    end
+    class << self
+      attr_reader :prompts_path
 
-    private
+      def prompts_path
+        @prompts_path ||= detect_prompts_path
+      end
 
-    # Split the template parameter into type and prompt
-    #
-    # @param template [String] Template path in the format 'type/prompt' (e.g., 'rag/system')
-    # @return [Array<String, String>] An array containing the type and prompt
-    def self.split_template(template)
-      template.split('/')
-    end
+      # Render a prompt by reading and rendering the YAML template
+      #
+      # @param template [String] The path to the template file, formatted as 'folder1/folder2/prompt'
+      # @param locals [Hash] Variables to be passed to the template for rendering
+      #
+      # @return [String] Rendered prompt
+      def render(template:, locals: {})
+        path, prompt = split_template(template)
+        file_path = prompt_file_path(path, prompt)
+
+        raise "Prompt file not found: #{file_path}" unless File.exist?(file_path)
+
+        # Preprocess the locals before rendering the YAML file
+        preprocessed_locals = preprocess_locals(locals)
+
+        template_content = File.read(file_path)
+        erb_template = ERB.new(template_content)
+
+        context = Context.new(preprocessed_locals)
+        rendered_prompt = erb_template.result(context.get_binding)
+
+        # YAML.safe_load returns a hash, so fetch the correct part based on the prompt
+        parsed_yaml = YAML.safe_load(rendered_prompt)[prompt]
+
+        # Convert special characters back after YAML processing
+        convert_special_chars_back(parsed_yaml)
+      rescue Errno::ENOENT
+        raise "Template file not found at path: #{file_path}"
+      rescue Psych::SyntaxError => e
+        raise "YAML Syntax Error in file #{file_path}: #{e.message}"
+      rescue StandardError => e
+        raise "Error rendering prompt for template '#{template}': #{e.message}"
+      end
 
-    # Build the path to the desired prompt file
-    #
-    # @param type [String] Name of the prompt folder
-    # @param prompt [String] Type of prompt (e.g., 'system', 'user')
-    #
-    # @return [String] Full path to the template file
-    def self.prompt_file_path(type, prompt)
-      "#{PROMPTS_PATH}/#{type}/#{prompt}.yml.erb"
-    end
+      private
 
-    # Preprocess locals recursively to escape special characters in strings
-    #
-    # @param value [Object] The value to process (string, array, hash, etc.)
-    # @return [Object] Processed value with special characters escaped
-    def self.preprocess_locals(value)
-      case value
-      when String
-        escape_special_chars(value)
-      when Hash
-        value.transform_values { |v| preprocess_locals(v) } # Recurse into hash values
-      when Array
-        value.map { |item| preprocess_locals(item) } # Recurse into array items
-      else
-        value
+      # Detects the appropriate path for prompt templates
+      def detect_prompts_path
+        File.join(Dir.pwd, 'app', 'spectre', 'prompts')
       end
-    end
 
-    # Escape special characters in strings to avoid YAML parsing issues
-    #
-    # @param value [String] The string to process
-    # @return [String] The processed string with special characters escaped
-    def self.escape_special_chars(value)
-      value.gsub('&', '&amp;')
-           .gsub('<', '&lt;')
-           .gsub('>', '&gt;')
-           .gsub('"', '&quot;')
-           .gsub("'", '&#39;')
-           .gsub("\n", '\\n')
-           .gsub("\r", '\\r')
-           .gsub("\t", '\\t')
-    end
+      # Split the template parameter into path and prompt
+      #
+      # @param template [String] Template path in the format 'folder1/folder2/prompt'
+      # @return [Array<String, String>] An array containing the folder path and the prompt name
+      def split_template(template)
+        *path_parts, prompt = template.split('/')
+        [File.join(path_parts), prompt]
+      end
 
-    # Convert special characters back to their original form after YAML processing
-    #
-    # @param value [String] The string to process
-    # @return [String] The processed string with original special characters restored
-    def self.convert_special_chars_back(value)
-      value.gsub('&amp;', '&')
-           .gsub('&lt;', '<')
-           .gsub('&gt;', '>')
-           .gsub('&quot;', '"')
-           .gsub('&#39;', "'")
-           .gsub('\\n', "\n")
-           .gsub('\\r', "\r")
-           .gsub('\\t', "\t")
+      # Build the path to the desired prompt file
+      #
+      # @param path [String] Path to the prompt folder(s)
+      # @param prompt [String] Name of the prompt file (e.g., 'system', 'user')
+      #
+      # @return [String] Full path to the template file
+      def prompt_file_path(path, prompt)
+        File.join(prompts_path, path, "#{prompt}.yml.erb")
+      end
+
+      # Preprocess locals recursively to escape special characters in strings
+      #
+      # @param value [Object] The value to process (string, array, hash, etc.)
+      # @return [Object] Processed value with special characters escaped
+      def preprocess_locals(value)
+        case value
+        when String
+          escape_special_chars(value)
+        when Hash
+          value.transform_values { |v| preprocess_locals(v) } # Recurse into hash values
+        when Array
+          value.map { |item| preprocess_locals(item) } # Recurse into array items
+        else
+          value
+        end
+      end
+
+      # Escape special characters in strings to avoid YAML parsing issues
+      #
+      # @param value [String] The string to process
+      # @return [String] The processed string with special characters escaped
+      def escape_special_chars(value)
+        value.gsub('&', '&amp;')
+             .gsub('<', '&lt;')
+             .gsub('>', '&gt;')
+             .gsub('"', '&quot;')
+             .gsub("'", '&#39;')
+             .gsub("\n", '\\n')
+             .gsub("\r", '\\r')
+             .gsub("\t", '\\t')
+      end
+
+      # Convert special characters back to their original form after YAML processing
+      #
+      # @param value [String] The string to process
+      # @return [String] The processed string with original special characters restored
+      def convert_special_chars_back(value)
+        value.gsub('&amp;', '&')
+             .gsub('&lt;', '<')
+             .gsub('&gt;', '>')
+             .gsub('&quot;', '"')
+             .gsub('&#39;', "'")
+             .gsub('\\n', "\n")
+             .gsub('\\r', "\r")
+             .gsub('\\t', "\t")
+      end
     end
 
     # Helper class to handle the binding for ERB template rendering

data/lib/spectre/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spectre # :nodoc:all
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectre_ai
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ilya Klapatok
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails