ai-prompt-organizer v0.1.10

AI Prompt Organizer

Super simple and scalable AI prompt management tools

• Access prompts the same way they are organized in your folder/file system
• Use any prompt inside of another prompt
• Avoid bloating your code files with blocks of prompt text (separation of concerns)
• Easily add variables and logic to your prompts using Liquid - Shopify's Template Language
• Check out the example project

Table of Contents

• Quick Start
• How to organize and use your prompts + examples
• Input variables + examples
• Use prompts in other prompts + examples
• API Reference
• TODO List

Quick Start

1. Install the package.

npm install ai-prompt-organizer

2. Create a prompts directory in the root of your project. Add an index.cjs file.

mkdir prompts
cd prompts
touch index.cjs

Not sure what .cjs is? Learn more here

3. In index.cjs, default export an object of prompts.

module.exports = {
  greetings: {
    hello: "Hi GPT!",
    poseQuestion: "I have a question.",
  },

  respondInStyle: "Write your response in the style of",

  writingStyles: {
    mobster: "a mobster from the 1920s",
    celebs: {
      misterRogers: "Mr. Rogers",
    },
  },

  ageAppropriate:
    "{{important}} Make your response appropriate for someone who is {{inputs.age}} years old.",

  fullPrompt: `
    {{greetings.hello}} {{greetings.poseQuestion}}
    {{inputs.question}}
    {{respondInStyle}} {{writingStyles.celebs.misterRogers}}.
    {{ageAppropriate}}
    `

}

NOTE: Right now, common js modules are required to accomodate older Node projects.

4. Use your prompts!

import PromptOrganizer from "ai-prompt-organizer"

const inputs = { question: "Why do zebras have stripes?", age: 10 };
const prompt = PromptOrganizer.get("fullPrompt", inputs)

console.log(prompt)
// Hi GPT! I have a question.
// Why do zebras have stripes?
// Write your response in the style of Mr. Rogers.
// IMPORTANT! Make your response appropriate for someone who is 10 years old.

How it works

File/Module Organization === Prompt Organization

Your prompt library is a directory comprised of other directories and .cjs files.

/prompts
  index.cjs
  superLongPrompt.cjs
  constants.cjs
  /constants <-- Will merge with constants.cjs
    math.cjs
  /formats
    bullets.cjs
    numbered.cjs
    /xml
      statistics.cjs
      listsOfText.cjs

Prompt files have flexible export options

Currently limited to common/es5 module export system.

1. Default export an object of prompts

<-- prompts/constants.cjs -->

const currencies = {
  USD: "american dollar",
  EUR: "euro"
}

const defaultLanguage = "English"

module.exports = {
  currencies,
  defaultLanguage
}

2. Export prompts as named exports

<-- prompts/constants/math.cjs -->

module.exports.pi = Math.PI.toFixed(2)

3. Export just the prompt

<-- prompts/superLongPrompt.cjs -->

module.exports = `
    This is theoretically a super long prompt (maybe as long as all the decimals in pi ({{constants.math.pi}}... etc.)

    So you may want a whole file dedicated to just this prompt.
`

Your file and object/export structures determine how you access your prompts.

Using the file examples above...

PromptOrganizer.get("constants.defaultLanguage")
// "English"

PromptOrganizer.get("constants.currencies.EUR")
// "euro"

PromptOrganizer.get("constants.math.pi")
// "3.14"

PromptOrganizer.get("superLongPrompt")
// "This is theoretically a super long prompt (maybe as long as all the decimals in pi (3.14... etc.)
//
// So you may want a whole file dedicated to just this prompt."

Input variables

Provide prompts with inputs in order to inject dynamic data into the text.

const prompt = `I have a new question: {{inputs.question}}`

PromptOrganizer.use(prompt, {
  question: "How do I use ai-prompt-organizer?"
})
// "I have a new question: How do I use ai-prompt-organizer?"

Use prompts in other prompts

Any prompt can reference any other prompt, regardless of where it's located in your prompt library.

BUT, be careful of circular dependencies!!!!

<-- prompts/index.cjs -->

const promptA = "This is a prompt with {{superNestedObjectOfPrompts.top.middle.bottom.deepPrompt}}"
const promptB = "This is prompt b"

const superNestedObjectOfPrompts = {
  top: {
    middle: {
      bottom: {
        deepPrompt: "This is a deep prompt with {{promptB}}"
      }
    }
  }
}

module.exports = {
  promptA,
  promptB,
  superNestedObjectOfPrompts
}

// WARNING - THESE ARE CIRCULAR DEPENDENCIES
// They will result in blank strings
const prompt1 = "{{prompt2}} and {{prompt3}}"
const prompt2 = "{{prompt1}} and {{prompt3}}"
const prompt3 = "{{prompt1}} and {{prompt2}}"

API Reference

PromptOrganizer

PromptOrganizer.init({
  source: path.join(__dirname, "customPromptLibraryRoot"),
  debug: true
})

.get(promptKey: string, inputs?: object) Get a prompt by it's reference key and pass in optional inputs.

PromptOrganizer.get("some.prompt.uses.input", { user: "Ryan" })

.use(prompt: string, inputs?: object) Use a custom prompt directly and pass in optional inputs.

PromptOrganizer.use("My name is {{name}}", { name: "Ryan" })

.logPrompts() View your prompts in structured output for debugging purposes.

PromptOrganizer.logPrompts()

TODO List

This is a super young package, so lots to improve on. Open an issue with suggestions!

• this within the same file
• Use of es6 modules