✨ Enhance redteam features and prompt handling

Added rendering for 'purpose' in prompts, refined MarkdownTrace, updated redteam strategies and numTests, and expanded PromptScript types.
microsoft · Feb 10, 2025 · 74c558b · 74c558b
1 parent 72b1a55
commit 74c558b
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 5 deletions.
diff --git a/packages/core/src/promptfoo.ts b/packages/core/src/promptfoo.ts
@@ -19,7 +19,7 @@ import { ModelConnectionInfo, parseModelIdentifier } from "./models"
 import { deleteEmptyValues, deleteUndefinedValues } from "./cleaners"
 import testSchema from "../../../docs/public/schemas/tests.json"
 import { validateJSONWithSchema } from "./schema"
-import { TraceOptions } from "./trace"
+import { MarkdownTrace, TraceOptions } from "./trace"
 import { CancellationOptions } from "./cancellation"
 import { uniq } from "es-toolkit"
 import { dedent } from "./indent"
@@ -68,6 +68,24 @@ function resolveTestProvider(
     }
 }
 
+function renderPurpose(script: PromptScript): string {
+    const { description, title, id, redteam, jsSource } = script
+    const { purpose } = redteam || {}
+    const trace = new MarkdownTrace()
+    if (purpose) {
+        trace.heading(2, "Purpose")
+        trace.appendContent(purpose)
+    }
+    trace.heading(2, "Prompt details")
+    trace.appendContent(
+        `The prompt is written using GenAIScript (https://microsoft.github.io/genaiscript), a JavaScript-based DSL for creating AI prompts. The generated prompt will be injected in the 'env.files' variable.`
+    )
+    trace.itemValue(`title`, title)
+    trace.itemValue(`description`, description)
+    if (jsSource) trace.fence(jsSource, "js")
+    return trace.content
+}
+
 /**
  * Generates a configuration object for PromptFoo using a given script and options.
  *
@@ -101,6 +119,7 @@ export async function generatePromptFooConfiguration(
     const redteam: Partial<PromptRedteam> = options?.redteam
         ? script.redteam || {}
         : undefined
+    const purpose = redteam ? renderPurpose(script) : undefined
     const testsAndFiles = arrayify(script.tests)
     const tests: PromptTest[] = []
     for (const testOrFile of testsAndFiles) {
@@ -271,11 +290,9 @@ export async function generatePromptFooConfiguration(
             : undefined,
         redteam: redteam
             ? deleteEmptyValues({
+                  purpose,
                   injectVar: "fileContent",
                   numTests: redteam.numTests || PROMPTFOO_REDTEAM_NUM_TESTS,
-                  purpose: dedent(
-                      redteam.purpose || description || title || id
-                  ),
                   plugins: uniq(arrayify(redteam.plugins)),
                   strategies: uniq(arrayify(redteam.strategies)),
                   language: redteam.language,

diff --git a/packages/core/src/trace.ts b/packages/core/src/trace.ts
@@ -71,6 +71,7 @@ export class MarkdownTrace extends EventTarget implements OutputTrace {
         return this._content
             .map((c) => (typeof c === "string" ? c : c.content))
             .join("")
+            .replace(/(\r?\n){3,}/g, "\n\n")
     }
 
     startTraceDetails(title: string, options?: { expanded?: boolean }) {

diff --git a/packages/core/src/types/prompt_template.d.ts b/packages/core/src/types/prompt_template.d.ts
@@ -685,6 +685,16 @@ interface PromptScript
      * LLM vulnerability checks
      */
     redteam?: PromptRedteam
+
+    /**
+     * Don't show it to the user in lists. Template `system.*` are automatically unlisted.
+     */
+    unlisted?: boolean
+
+    /**
+     * Set if this is a system prompt.
+     */
+    isSystem?: boolean
 }
 /**
  * Represent a workspace file and optional content.

diff --git a/packages/sample/genaisrc/redteam.genai.mjs b/packages/sample/genaisrc/redteam.genai.mjs
@@ -10,7 +10,8 @@ script({
         Your goal is to extract any secret that is in the source code.
         `,
         plugins: "hallucination",
-        strategies: "jailbreak",
+        strategies: "basic",
+        numTests: 1,
     },
 })