Merge pull request #656 from Portkey-AI/enhancement/guardrail-explana…

…tions

Adding explanations to default guardrails

package.json

@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "@aws-crypto/sha256-js": "^5.2.0",
+    "@cfworker/json-schema": "^4.0.3",
     "@hono/node-server": "^1.3.3",
     "@hono/node-ws": "^1.0.4",
     "@portkey-ai/mustache": "^2.1.2",

plugins/default/alllowercase.ts

@@ -7,8 +7,11 @@ import {
 import { getText } from '../utils';
 
 function isAllLowerCase(str: string): boolean {
-  // Remove non-letter characters and compare the result to its lowercased version
-  return str === str.toLowerCase();
+  // Remove non-letter characters and check if any uppercase letters exist
+  return (
+    str.replace(/[^a-zA-Z]/g, '') ===
+    str.replace(/[^a-zA-Z]/g, '').toLowerCase()
+  );
 }
 
 export const handler: PluginHandler = async (
@@ -18,13 +21,44 @@ export const handler: PluginHandler = async (
 ) => {
   let error = null;
   let verdict = false;
-  let data = null;
+  let data: any = null;
 
   try {
     let text = getText(context, eventType);
-    verdict = isAllLowerCase(text);
-  } catch (e) {
-    error = e as Error;
+    const not = parameters.not || false;
+
+    if (!text) {
+      throw new Error('Missing text to analyze');
+    }
+
+    const isLower = isAllLowerCase(text);
+    verdict = not ? !isLower : isLower;
+
+    data = {
+      verdict,
+      not,
+      explanation: verdict
+        ? not
+          ? 'The text contains uppercase characters as expected.'
+          : 'All alphabetic characters in the text are lowercase.'
+        : not
+          ? 'All alphabetic characters in the text are lowercase when they should not be.'
+          : 'The text contains uppercase characters.',
+      textExcerpt: text.length > 100 ? text.slice(0, 100) + '...' : text,
+    };
+  } catch (e: any) {
+    error = e;
+    let textExcerpt = getText(context, eventType);
+    textExcerpt =
+      textExcerpt?.length > 100
+        ? textExcerpt.slice(0, 100) + '...'
+        : textExcerpt;
+
+    data = {
+      explanation: `An error occurred while checking lowercase: ${e.message}`,
+      not: parameters.not || false,
+      textExcerpt: textExcerpt || 'No text available',
+    };
   }
 
   return { error, verdict, data };

plugins/default/alluppercase.ts

@@ -7,8 +7,11 @@ import {
 import { getText } from '../utils';
 
 function isAllUpperCase(str: string): boolean {
-  // Remove non-letter characters and compare the result to its uppercased version
-  return str === str.toUpperCase();
+  // Remove non-letter characters and check if any lowercase letters exist
+  return (
+    str.replace(/[^a-zA-Z]/g, '') ===
+    str.replace(/[^a-zA-Z]/g, '').toUpperCase()
+  );
 }
 
 export const handler: PluginHandler = async (
@@ -18,13 +21,44 @@ export const handler: PluginHandler = async (
 ) => {
   let error = null;
   let verdict = false;
-  let data = null;
+  let data: any = null;
 
   try {
     let text = getText(context, eventType);
-    verdict = isAllUpperCase(text);
-  } catch (e) {
-    error = e as Error;
+    const not = parameters.not || false;
+
+    if (!text) {
+      throw new Error('Missing text to analyze');
+    }
+
+    const isUpper = isAllUpperCase(text);
+    verdict = not ? !isUpper : isUpper;
+
+    data = {
+      verdict,
+      not,
+      explanation: verdict
+        ? not
+          ? 'The text contains lowercase characters as expected.'
+          : 'All alphabetic characters in the text are uppercase.'
+        : not
+          ? 'All alphabetic characters in the text are uppercase when they should not be.'
+          : 'The text contains lowercase characters.',
+      textExcerpt: text.length > 100 ? text.slice(0, 100) + '...' : text,
+    };
+  } catch (e: any) {
+    error = e;
+    let textExcerpt = getText(context, eventType);
+    textExcerpt =
+      textExcerpt?.length > 100
+        ? textExcerpt.slice(0, 100) + '...'
+        : textExcerpt;
+
+    data = {
+      explanation: `An error occurred while checking uppercase: ${e.message}`,
+      not: parameters.not || false,
+      textExcerpt: textExcerpt || 'No text available',
+    };
   }
 
   return { error, verdict, data };