kerplunk-ai-prompts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f39c88fe4bac3bb08cb9a8f52f30360831f219518c95c1fd600133d14e800473
+  data.tar.gz: d5e3d7bc404e0a74cd1d88c3f00a3db28c88b0829352eb9023c98b67b9f8c823
+SHA512:
+  metadata.gz: e5ef8534948d80d132591b58772ebd3a7fcaa58cbea02876d8ed2243e1bcb192ea23fab5dfb6db11a8897adc157d01c521063b27532b5e95fe002b6aa41ed87f
+  data.tar.gz: c6b6a0cdb09389bc156458cb99d68ea026faa0b12003c431739a8bf78227f549ad640409767e5a73bf4b00a703823ac0be415d1a3bdc807a4a96658ae9fc7d64

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kschutt@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Kyle Schutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Kerplunk::AI::Prompts
+
+[![Ruby](https://github.com/KerplunkAI/kerplunk-ai-prompts/actions/workflows/main.yml/badge.svg)](https://github.com/KerplunkAI/kerplunk-ai-prompts/actions/workflows/main.yml)
+
+Kerplunk::AI::Prompts is a collection of AI prompt templates for use in Kerplunk. It includes templates for generating job descriptions, interview questions, and analyzing resumes and interviews.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add kerplunk-ai-prompts
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install kerplunk-ai-prompts
+
+## Usage
+
+To generate a prompt, use the `generate_prompt` method with the appropriate prompt key and arguments. Example:
+
+```ruby
+require 'kerplunk/ai/prompts'
+prompt = Kerplunk::AI::Prompts.generate_prompt(:job_description, job_title, industry, organization_name, organization_size, job_location, job_description, raw_string)
+puts prompt
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kerplunk-ai-prompts. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/kerplunk-ai-prompts/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kerplunk::AI::Prompts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/kerplunk-ai-prompts/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/config/initializers/inflections.rb

@@ -0,0 +1,5 @@
+require "active_support/inflector"
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "AI"
+end

data/lib/kerplunk/ai/models/interview_question.rb

@@ -0,0 +1,41 @@
+module Kerplunk
+  module AI
+    module Models
+      # Represents an interview question with its associated details.
+      class InterviewQuestion
+        attr_accessor :index, :content, :suggested_answers, :transcript, :category, :previous_score
+
+        # Initializes a new InterviewQuestion object.
+        #
+        # @param index [Integer] the index of the question
+        # @param content [String] the content of the question
+        # @param suggested_answers [String] the suggested answers for the question
+        # @param transcript [String, nil] the transcript of the interview related to the question
+        # @param category [String] the category of the question
+        # @param previous_score [Float] the previous score of the question
+        def initialize(index:, content:, suggested_answers:, category:, previous_score:, transcript: nil)
+          @index = index
+          @content = content
+          @suggested_answers = suggested_answers
+          @transcript = transcript.nil? ? "<NOTRANSCRIPT />" : transcript
+          @category = category
+          @previous_score = previous_score
+        end
+
+        # Generates a formatted prompt for the interview question.
+        #
+        # @return [String] the formatted question prompt
+        def question_prompt
+          <<~QUESTION_PROMPT
+            ==== Question No. #{index + 1}
+            Question Text: #{content}
+            Suggested Answer: #{suggested_answers}
+            Transcript: #{transcript}
+            Category: #{category}
+            Previous Score: #{previous_score}
+          QUESTION_PROMPT
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/prompt_handler.rb

@@ -0,0 +1,40 @@
+require_relative "templates/generation/interview_questions"
+require_relative "templates/generation/job_description"
+require_relative "templates/analysis/interview"
+require_relative "templates/analysis/interview_question"
+require_relative "templates/analysis/resume"
+
+module Kerplunk
+  module AI
+    module Prompts
+      # The PromptHandler module is responsible for handling different types of prompts
+      # based on the provided prompt key. It delegates the prompt generation to the
+      # appropriate template class.
+      module PromptHandler
+        # Handles the prompt generation based on the provided prompt key.
+        #
+        # @param prompt_key [Symbol] the key representing the type of prompt to generate
+        # @param args [Array] additional arguments to pass to the prompt generation method
+        # @param kwargs [Hash] additional keyword arguments to pass to the prompt generation method
+        # @return [String] the generated prompt
+        # @raise [RuntimeError] if the prompt key is unknown
+        def self.handle_prompt(prompt_key, *args, **kwargs)
+          case prompt_key
+          when :interview_questions
+            Templates::Generation::InterviewQuestions.generate_prompt(*args)
+          when :job_description
+            Templates::Generation::JobDescription.generate_prompt(*args)
+          when :interview_question_analysis
+            Templates::Analysis::InterviewQuestion.generate_prompt(*args)
+          when :interview_analysis
+            Templates::Analysis::Interview.generate_prompt(*args)
+          when :resume_analysis
+            Templates::Analysis::Resume.generate_prompt(*args)
+          else
+            raise "Unknown prompt key: #{prompt_key}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/templates/analysis/interview.rb

@@ -0,0 +1,131 @@
+module Kerplunk
+  module AI
+    module Prompts
+      module Templates
+        module Analysis
+          # The Interview class is responsible for generating a prompt for interview analysis.
+          class Interview
+            # Generates a prompt for analyzing an interview.
+            #
+            # @param job_title [String] the title of the job for which the interview is being conducted
+            # @param job_description [String] the description of the job for which the interview is being conducted
+            # @param organization_name [String] the name of the organization conducting the interview
+            # @param question_models [Array<Kerplunk::AI::Models::InterviewQuestion>] an array of InterviewQuestion objects
+            # @return [String] the generated prompt for the interview analysis
+            # @raise [TypeError] if question_models is not an array of InterviewQuestion objects
+            def self.generate_prompt(job_title, job_description, organization_name, question_models)
+              raise ArgumentError, "job_title is required" if job_title.nil? || job_title.empty?
+              raise ArgumentError, "job_description is required" if job_description.nil? || job_description.empty?
+              raise ArgumentError, "organization_name is required" if organization_name.nil? || organization_name.empty?
+
+              raise TypeError, "question_models must be an array of InterviewQuestion objects" unless question_models.is_a?(Array) && question_models.all? { |qm| qm.is_a?(Kerplunk::AI::Models::InterviewQuestion) }
+
+              question_answer_prompts = question_models.collect(&:question_prompt)
+
+              <<~PROMPT
+                You are an expert recruiter. You are performing the interview of a candidate to effectively evaluate them for a new role at #{organization_name}.
+
+                === Nonnegotiables for the interview analysis
+
+                - If there is a lack of data, please provide a score of 0.
+                - Please do not be afraid to mention in the commentary if there is not enough data to provide an opinion.
+                - If there are inconsistencies in the transcripts, please double-check your analysis.
+                - Please highlight any red flags or toxic behavior.
+                - Always ensure that all the provided JSON format has a value even if there is not enough data available. Providing a score of 0 or stating there is not enough information is perfectly fine.
+                - If a phone screen would be more appropriate, please do not hesitate to indicate that in your analysis.
+
+                === The Indicators
+
+                When analyzing the interview, please consider the following 6 indicators:
+
+                1. Interview Score
+
+                This is the overall score of the interview and how well the candidate fits the job description.
+
+                2. X-Factor Score
+
+                This is the score of the candidate's personality and cultural fit. This should be something that stood out during the interview or something that the candidate has that is unique and valuable.
+
+                3. Soft Skills Score
+
+                This is the score of the candidate's soft skills. This should be based on inflection and word choice. Please consider their use of language and how they present themselves.
+
+                4. Resume Score
+
+                Based on the candidate's interview, provide a prediction on how the resume will score. This should be based on the candidate's experience and how well they fit the job description.
+
+                5. Culture Fit Score
+
+                This is the score of the candidate's personality and cultural fit. This should be based on the candidate's personality and how well they fit the company culture.
+
+                6. Technical Score
+
+                This is the score of the candidate's technical skills. This should be based on the candidate's technical knowledge and how well they fit the job description.
+
+                === The Commentary
+
+                In addition to scoring the candidate on various indicators, please provide commentary on the following. We are looking for a short comment on each category as well as a longer detailed commentary.
+
+                1. Analysis
+
+                Overall analysis of the candidate and how they fit the job description and the company culture. The output should include a summary paragraph followed by three succinct highlights in an array.
+
+                2. Soft Skills
+
+                The candidate's soft skills and how they presented themselves during the interview.
+
+                3. Culture Fit
+
+                The candidate's personality and cultural fit.
+
+                4. Feedback
+
+                In the third person voice, generate a one-paragraph feedback report. Analyze the interview for content relevance and depth, determine communication effectiveness, and evaluate cues for professional presentation. Provide specific examples from the interview to substantiate your points and offer constructive suggestions for improvement where applicable.
+
+                === JSON Output Example
+                Please output the scores in a JSON object. Please make sure that the scores are aggregated by category and are between 1 and 100. An example output should be JSON and look like the below. Please be sure the output is a valid JSON format even if you cannot generate the interview questions. The JSON should not include any markdown or newline characters such as "```json" that would normally be used for rendering in markdown.
+
+                {
+                  "scores": {
+                    "interview_score": 4.5,
+                    "x_factor_score": 4.5,
+                    "soft_skills_score": 4.5,
+                    "resume_score": 4.5,
+                    "culture_fit_score": 4.5,
+                    "technical_score": 4.5
+                  },
+                  "commentary": {
+                    "analysis": "The candidate overview",
+                    "soft_skills": "The candidate's soft skills",
+                    "culture_fit": "The candidate's personality and cultural fit",
+                    "feedback": "Feedback for the candidate"
+                  },
+                  "detailed_commentary": {
+                    "overview": "The candidate overview of how they did",
+                    "conclusion": "The conclusion of the interview",
+                    "experience": "The candidate's experience and expertise",
+                    "adaptability": "The candidate's adaptability and efficiency",
+                    "communication": "The candidate's communication skills and empathy",
+                    "professionalism": "The candidate's professionalism and work ethic and dedication",
+                    "continuous_improvement": "The candidate's continuous improvement and learning and education",
+                    "financial_impact": "The candidate's financial impact and cost-effectiveness and value alignment"
+                  }
+                }
+
+                === The Job Title
+                #{job_title}
+
+                === The Job Description
+                #{job_description}
+
+                === The Interview Questions with the Transcript of the Interview Answers (some answers may have a score from a previous analysis, please aggregate these scores by category). Some Interview Questions will provide an array of suggested answers, please evaluate the Transcript answer against the suggested answers where each one could be the correct answer.
+
+                #{question_answer_prompts.join("\n\n")}
+              PROMPT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/templates/analysis/interview_question.rb

@@ -0,0 +1,49 @@
+module Kerplunk
+  module AI
+    module Prompts
+      module Templates
+        module Analysis
+          # The InterviewQuestion class is responsible for generating prompts for interview questions.
+          class InterviewQuestion
+            # Generates a prompt for evaluating a candidate's response to an interview question.
+            #
+            # @param question [String] the interview question being asked
+            # @param question_type [String] the type/category of the interview question
+            # @param transcript [String] the transcript of the candidate's response
+            # @return [String] the generated prompt
+            def self.generate_prompt(question, question_type, transcript)
+              raise ArgumentError, "question is required" if question.nil? || question.empty?
+              raise ArgumentError, "question_type is required" if question_type.nil? || question_type.empty?
+
+              transcript = "<NOTRANSCRIPT />" if transcript.nil? || transcript.empty?
+
+              <<~PROMPT
+                You are an expert recruiter. You are performing the interview of a candidate to effectively evaluate them for their #{question_type} skills. Please provide a score from 1 to 100. Please provide three high-level bullet pointed comments about how the candidate did on the question as the `commentary` key.
+
+                Please ensure the following:
+                - If no transcript is available (denoted by <NOTRANSCRIPT />), a score of 0 is assigned
+                - The commentary is a high-level bullet pointed comments about how the candidate did on the question
+
+                An example output should be JSON and look like this:
+                {
+                  "commentary": [
+                    "Comment 1",
+                    "Comment 2",
+                    "Comment 3"
+                  ],
+                  "score": 4.5
+                }
+
+                Please remember that the question category is #{question_type} and the question is:
+                #{question}
+
+                This is the transcript of the Interview Answers:
+                #{transcript}
+              PROMPT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/templates/analysis/resume.rb

@@ -0,0 +1,102 @@
+module Kerplunk
+  module AI
+    module Prompts
+      module Templates
+        module Analysis
+          # The Resume class is responsible for generating a prompt for resume analysis.
+          class Resume
+            # Generates a prompt for analyzing a resume.
+            #
+            # @param organization_name [String] the name of the organization conducting the interview
+            # @param job_title [String] the title of the job for which the resume is being analyzed
+            # @param job_description [String] the description of the job for which the resume is being analyzed
+            # @param resume_text [String] the text of the candidate's resume
+            # @return [String] the generated prompt
+            def self.generate_prompt(organization_name, job_title, job_description, resume_text)
+              raise ArgumentError, "organization_name is required" if organization_name.nil? || organization_name.empty?
+              raise ArgumentError, "job_title is required" if job_title.nil? || job_title.empty?
+              raise ArgumentError, "job_description is required" if job_description.nil? || job_description.empty?
+              raise ArgumentError, "resume_text is required" if resume_text.nil? || resume_text.empty?
+
+              <<~PROMPT
+                You are an expert recruiter. You are performing the interview of a candidate to effectively evaluate them for a new role at #{organization_name}. Please analyze the resume added after `====`. Please provide a score from 1 to 100.
+
+                === The Job Title
+                #{job_title}
+
+                === The Job Description
+                #{job_description}
+
+                === Nonnegotiables for analyses on the resume
+
+                - If there is a lack of data, please provide a score of 0.
+                - Please do not be afraid to mention in the commentary if there is not enough data to provide an opinion.
+                - If there are inconsistencies in the transcripts, please double-check your analysis.
+                - Please highlight any red flags or toxic behavior.
+                - Always ensure that all the provided JSON format has a value even if there is not enough data available. Providing a score of 0 or stating there is not enough information is perfectly fine.
+                - If a phone screen would be more appropriate, please do not hesitate to indicate that in your analysis.
+                - Please attempt to extract the following from the resume: phone number, current title, current experience level, and current location.
+
+                === The Indicators
+
+                When analyzing the interview, please consider the following 6 indicators:
+
+                1. Interview Score
+
+                Based on the candidate's resume, provide a prediction of the interview and how well the candidate fits the job description.
+
+                2. X-Factor Score
+
+                This is the score of the candidate's personality and cultural fit. This should be something that stood out on the resume or something that the candidate has that is unique and valuable.
+
+                3. Soft Skills Score
+
+                This is the score of the candidate's soft skills. This should be based on inflection and word choice. Please consider their use of language and how they present themselves.
+
+                4. Resume Score
+
+                This should be based on the candidate's experience and how well they fit the job description.
+
+                5. Culture Fit Score
+
+                This is the score of the candidate's personality and cultural fit. This should be based on the candidate's personality and how well they fit the company culture.
+
+                6. Technical Score
+
+                This is the score of the candidate's technical skills. This should be based on the candidate's technical knowledge and how well they fit the job description.
+
+                An example output should be JSON and look like the below. Please be sure the output is a valid JSON format even if you cannot generate the interview questions. The JSON should not include any markdown or newline characters such as "```json" that would normally be used for rendering in markdown.
+                === JSON Output
+                {
+                  "scores": {
+                    "interview_score": 4.5,
+                    "x_factor_score": 4.5,
+                    "soft_skills_score": 4.5,
+                    "resume_score": 4.5,
+                    "culture_fit_score": 4.5,
+                    "technical_score": 4.5
+                  },
+                  "commentary": {
+                    "analysis": "The candidate overview",
+                    "soft_skills": "The candidate's soft skills",
+                    "culture_fit": "The candidate's personality and cultural fit",
+                    "feedback": "Feedback for the candidate"
+                  },
+                  "details": {
+                    "phone_number": "The candidate's phone number",
+                    "current_title": "The candidate's current title",
+                    "experience_level": "The candidate's experience level",
+                    "current_location": "The candidate's current location"
+                  }
+                }
+
+                ====
+                #{resume_text}
+              PROMPT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/templates/generation/interview_questions.rb

@@ -0,0 +1,55 @@
+module Kerplunk
+  module AI
+    module Prompts
+      module Templates
+        module Generation
+          class InterviewQuestions
+            # Generates a prompt for creating interview questions based on the provided job description.
+            #
+            # @param description [String] the job description to base the interview questions on
+            # @return [String] the generated prompt for interview questions
+            def self.generate_prompt(description)
+              raise ArgumentError, "description is required" if description.nil? || description.empty?
+
+              <<~PROMPT
+                You are an expert recruiter. You are performing the interview of a candidate to effectively evaluate them on all fronts: personal skills, technical skills, job-specific skills, soft-skills, and the “x-factor”. The interview should start off with a few questions about the candidate, then go to exactly 5 questions regarding the job posting listed below after ###, and then finally please ask a few questions to help assess personality and cultural fit (you can be creative here). These questions should aim to be simple, effective, empathetic, non-biased, and descriptive enough to be used in further prompts when analyzing the results of the interview.
+
+                Please output the questions in a JSON array. Please make sure that there are 2-3 personal questions, exactly 5 questions regarding the job posting (at least 1 technical question should be about an example scenario), and 2-3 questions to assess personality and cultural fit.
+
+                Please ensure all questions:
+                - are unique. Please ensure there are no duplicate questions.
+                - are not too long.
+                - are grammatically correct.
+                - are not too similar to each other.
+                - are not offensive.
+                - do not contain any profanity.
+                - are not superficial.
+                - have some variety.
+                - maintain a consistent tone.
+                - flow well together.
+                - are not too similar to the job description.
+
+                Please ensure that the technical questions:
+                - are not too easy.
+                - are deep enough to assess the candidate’s technical knowledge.
+                - use industry standard terminology and jargon as much as possible.
+
+                If for any reason you are unable to generate the questions, please try again. Please check your output, and rerun the prompt if you are not satisfied with the results.
+
+                An example output should be JSON and look like the below. Please be sure the output is a valid JSON format even if you cannot generate the interview questions. The JSON should not include any markdown or newline characters such as "```json" that would normally be used for rendering in markdown.
+                {
+                  "personal_questions": ["question1", "question2", "question3"],
+                  "technical_questions": ["question4", "question5"],
+                  "cultural_questions": ["question6", "question7"]
+                }
+
+                ###
+                #{description}
+              PROMPT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/templates/generation/job_description.rb

@@ -0,0 +1,76 @@
+module Kerplunk
+  module AI
+    module Prompts
+      module Templates
+        module Generation
+          class JobDescription
+            # Generates a job description prompt for a given job title and organization.
+            #
+            # @param job_title [String] the title of the job position
+            # @param industry [String] the industry in which the organization operates
+            # @param organization_name_requirement [Boolean] whether the organization name is required in the description
+            # @param organization_name [String] the name of the organization to be highlighted
+            # @param organization_size [String] the size of the organization in terms of number of employees
+            # @param job_location [String] the location of the job
+            # @param job_description [String] the current job description, if any
+            # @param raw_string [String] the raw JSON string containing the full job listing details
+            # @return [String] the generated job description prompt
+            def self.generate_prompt(
+              job_title,
+              industry,
+              organization_name_requirement = true,
+              organization_name,
+              organization_size,
+              job_location,
+              job_description,
+              raw_string
+            )
+              raise ArgumentError, "job_title is required" if job_title.nil? || job_title.empty?
+              raise ArgumentError, "industry is required" if industry.nil? || industry.empty?
+              raise ArgumentError, "organization_name is required" if organization_name.nil? || organization_name.empty?
+              raise ArgumentError, "organization_size is required" if organization_size.nil? || organization_size.empty?
+              raise ArgumentError, "job_location is required" if job_location.nil? || job_location.empty?
+              raise ArgumentError, "job_description is required" if job_description.nil? || job_description.empty?
+
+              if organization_name_requirement
+                organization_name_requirement_text = "Please ensure the job description includes the organization name."
+              else
+                organization_name = "an organization"
+                organization_name_requirement_text = "Please ensure the job description does not include the organization name."
+              end
+              <<~PROMPT
+                You are an expert recruiter. You are creating a job description for "#{job_title}" for #{organization_name}. They are a key player in the "#{industry}" industry. They currently have a staff size of "#{organization_size} employees" and are looking for top-tier talent. Always include bullet points in the following sections: Responsibilities, Qualifications. If a description is provided below, please use that to help formulate a high-quality description.
+
+                Please ensure the description:
+                - is grammatically correct
+                - is not offensive
+                - does not contain any profanity
+                - is not superficial
+                - maintains a consistent tone
+                - Always include bullet points in the following sections: Responsibilities, Qualifications, Benefits, and Requirements
+                - Please ensure the generated HTML is valid
+                #{organization_name_requirement_text}
+
+                If for any reason you are unable to generate the description, please try again. Please check your output, and rerun the prompt if you are not satisfied with the results.
+
+                An example output should be JSON and look like this. The description should be formatted with valid HTML, not Markdown or newline characters.
+                {
+                  description: ""
+                }
+
+                === Job Location
+                #{job_location}
+
+                === Current Description
+                #{job_description}
+
+                === Full Job Listing JSON - Please consider the categories and subcategories carefully
+                #{raw_string}
+              PROMPT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kerplunk/ai/prompts/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kerplunk
+  module AI
+    module Prompts
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/kerplunk/ai/prompts.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "prompts/version"
+require_relative "prompts/prompt_handler"
+require_relative "models/interview_question"
+
+module Kerplunk
+  module AI
+    module Prompts
+      # Custom error class for the Prompts module
+      class Error < StandardError; end
+
+      class << self
+        # Returns an array of supported prompt keys.
+        #
+        # @return [Array<Symbol>] List of supported prompt keys.
+        def supported_prompt_keys
+          [
+            :interview_questions,
+            :job_description,
+            :interview_question_analysis,
+            :interview_analysis,
+            :resume_analysis
+          ]
+        end
+
+        # Generates a prompt based on the given prompt key and arguments.
+        #
+        # @param prompt_key [Symbol] The key representing the type of prompt to generate.
+        # @param args [Array] Additional arguments for the prompt generation.
+        # @param kwargs [Hash] Keyword arguments for the prompt generation.
+        # @return [String] The generated prompt.
+        # @raise [Error] if the prompt key is unknown.
+        def generate_prompt(prompt_key, *args, **kwargs)
+          PromptHandler.handle_prompt(prompt_key, *args, **kwargs)
+        rescue RuntimeError => e
+          raise Error, e.message
+        end
+      end
+    end
+  end
+end

data/sig/kerplunk/ai/prompts.rbs

@@ -0,0 +1,8 @@
+module Kerplunk
+  module AI
+    module Prompts
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: kerplunk-ai-prompts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Schutt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-19 00:00:00.000000000 Z
+dependencies: []
+description: A collection of AI prompt templates for use in Kerplunk
+email:
+- kschutt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/initializers/inflections.rb
+- lib/kerplunk/ai/models/interview_question.rb
+- lib/kerplunk/ai/prompts.rb
+- lib/kerplunk/ai/prompts/prompt_handler.rb
+- lib/kerplunk/ai/prompts/templates/analysis/interview.rb
+- lib/kerplunk/ai/prompts/templates/analysis/interview_question.rb
+- lib/kerplunk/ai/prompts/templates/analysis/resume.rb
+- lib/kerplunk/ai/prompts/templates/generation/interview_questions.rb
+- lib/kerplunk/ai/prompts/templates/generation/job_description.rb
+- lib/kerplunk/ai/prompts/version.rb
+- sig/kerplunk/ai/prompts.rbs
+homepage: https://kerplunk.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://kerplunk.com
+  source_code_uri: https://kerplunk.com
+  changelog_uri: https://kerplunk.com/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Kerplunk AI Prompt Templates
+test_files: []