@n8n/n8n-nodes-langchain 1.121.0 → 1.122.0

package/dist/nodes/Guardrails/description.js

@@ -18,15 +18,13 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var description_exports = {};
 __export(description_exports, {
-  versionDescription: () => versionDescription
+  propertiesDescription: () => propertiesDescription
 });
 module.exports = __toCommonJS(description_exports);
-var import_n8n_workflow = require("n8n-workflow");
 var import_jailbreak = require("./actions/checks/jailbreak");
 var import_nsfw = require("./actions/checks/nsfw");
 var import_pii = require("./actions/checks/pii");
 var import_topicalAlignment = require("./actions/checks/topicalAlignment");
-var import_configureNodeInputs = require("./helpers/configureNodeInputs");
 var import_model = require("./helpers/model");
 const THRESHOLD_OPTION = {
   displayName: "Threshold",
@@ -61,394 +59,357 @@ const wrapValue = (properties) => ({
   name: "value",
   values: properties
 });
-const versionDescription = {
-  displayName: "Guardrails",
-  name: "guardrails",
-  icon: "file:guardrails.svg",
-  group: ["transform"],
-  version: 1,
-  description: "Safeguard AI models from malicious input or prevent them from generating undesirable responses",
-  defaults: {
-    name: "Guardrails"
+const propertiesDescription = [
+  {
+    displayName: "Use guardrails to validate text against a set of policies (e.g. NSFW, prompt injection) or to sanitize it (e.g. personal data, secret keys)",
+    name: "guardrailsUsage",
+    type: "notice",
+    default: ""
   },
-  codex: {
-    alias: ["LangChain", "Guardrails", "PII", "Secret", "Injection", "Sanitize"],
-    categories: ["AI"],
-    subcategories: {
-      AI: ["Agents", "Miscellaneous", "Root Nodes"]
-    },
-    resources: {
-      primaryDocumentation: [
-        {
-          url: "https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-langchain.guardrails/"
-        }
-      ]
+  {
+    displayName: "Operation",
+    name: "operation",
+    type: "options",
+    noDataExpression: true,
+    options: [
+      {
+        name: "Check Text for Violations",
+        value: "classify",
+        action: "Check text for violations",
+        description: "Validate text against a set of policies (e.g. NSFW, prompt injection)"
+      },
+      {
+        name: "Sanitize Text",
+        value: "sanitize",
+        action: "Sanitize text",
+        // eslint-disable-next-line n8n-nodes-base/node-param-description-excess-final-period
+        description: "Redact text to mask personal data, secret keys, URLs, etc."
+      }
+    ],
+    default: "classify"
+  },
+  {
+    displayName: "Text To Check",
+    name: "text",
+    type: "string",
+    required: true,
+    default: "",
+    typeOptions: {
+      rows: 1
     }
   },
-  inputs: `={{(${import_configureNodeInputs.configureNodeInputs})($parameter.operation)}}`,
-  outputs: `={{
-		((parameters) => {
-			const operation = parameters.operation ?? 'classify';
-
-			if (operation === 'classify') {
-				return [{displayName: "Pass", type: "${import_n8n_workflow.NodeConnectionTypes.Main}"}, {displayName: "Fail", type: "${import_n8n_workflow.NodeConnectionTypes.Main}"}]
-			}
-
-			return [{ displayName: "", type: "${import_n8n_workflow.NodeConnectionTypes.Main}"}]
-		})($parameter)
-	}}`,
-  properties: [
-    {
-      displayName: "Use guardrails to validate text against a set of policies (e.g. NSFW, prompt injection) or to sanitize it (e.g. personal data, secret keys)",
-      name: "guardrailsUsage",
-      type: "notice",
-      default: ""
-    },
-    {
-      displayName: "Operation",
-      name: "operation",
-      type: "options",
-      noDataExpression: true,
-      options: [
-        {
-          name: "Check Text for Violations",
-          value: "classify",
-          action: "Check text for violations",
-          description: "Validate text against a set of policies (e.g. NSFW, prompt injection)"
-        },
-        {
-          name: "Sanitize Text",
-          value: "sanitize",
-          action: "Sanitize text",
-          // eslint-disable-next-line n8n-nodes-base/node-param-description-excess-final-period
-          description: "Redact text to mask personal data, secret keys, URLs, etc."
-        }
-      ],
-      default: "classify"
-    },
-    {
-      displayName: "Text To Check",
-      name: "text",
-      type: "string",
-      required: true,
-      default: "",
-      typeOptions: {
-        rows: 1
-      }
-    },
-    {
-      displayName: "Guardrails",
-      name: "guardrails",
-      placeholder: "Add Guardrail",
-      type: "collection",
-      default: {},
-      options: [
-        {
-          displayName: "Keywords",
-          name: "keywords",
-          type: "string",
-          default: "",
-          description: "This guardrail checks if specified keywords appear in the input text and can be configured to trigger tripwires based on keyword matches. Multiple keywords can be added separated by comma.",
-          displayOptions: {
-            show: {
-              "/operation": ["classify"]
-            }
+  {
+    displayName: "Guardrails",
+    name: "guardrails",
+    placeholder: "Add Guardrail",
+    type: "collection",
+    default: {},
+    options: [
+      {
+        displayName: "Keywords",
+        name: "keywords",
+        type: "string",
+        default: "",
+        description: "This guardrail checks if specified keywords appear in the input text and can be configured to trigger tripwires based on keyword matches. Multiple keywords can be added separated by comma.",
+        displayOptions: {
+          show: {
+            "/operation": ["classify"]
           }
-        },
-        {
-          displayName: "Jailbreak",
-          name: "jailbreak",
-          type: "fixedCollection",
-          default: { value: { threshold: 0.7 } },
-          description: "Detects attempts to jailbreak or bypass AI safety measures",
-          options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_jailbreak.JAILBREAK_PROMPT)])],
-          displayOptions: {
-            show: {
-              "/operation": ["classify"]
-            }
+        }
+      },
+      {
+        displayName: "Jailbreak",
+        name: "jailbreak",
+        type: "fixedCollection",
+        default: { value: { threshold: 0.7 } },
+        description: "Detects attempts to jailbreak or bypass AI safety measures",
+        options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_jailbreak.JAILBREAK_PROMPT)])],
+        displayOptions: {
+          show: {
+            "/operation": ["classify"]
           }
-        },
-        {
-          displayName: "NSFW",
-          name: "nsfw",
-          type: "fixedCollection",
-          default: { value: { threshold: 0.7 } },
-          description: "Detects attempts to generate NSFW content",
-          options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_nsfw.NSFW_SYSTEM_PROMPT)])],
-          displayOptions: {
-            show: {
-              "/operation": ["classify"]
-            }
+        }
+      },
+      {
+        displayName: "NSFW",
+        name: "nsfw",
+        type: "fixedCollection",
+        default: { value: { threshold: 0.7 } },
+        description: "Detects attempts to generate NSFW content",
+        options: [wrapValue([THRESHOLD_OPTION, ...getPromptOption(import_nsfw.NSFW_SYSTEM_PROMPT)])],
+        displayOptions: {
+          show: {
+            "/operation": ["classify"]
           }
-        },
-        {
-          displayName: "Personal Data (PII)",
-          name: "pii",
-          type: "fixedCollection",
-          default: { value: { type: "all" } },
-          description: "Detects attempts to use personal data content",
-          options: [
-            wrapValue([
-              {
-                displayName: "Type",
-                name: "type",
-                type: "options",
-                default: "",
-                options: [
-                  { name: "All", value: "all" },
-                  { name: "Selected", value: "selected" }
-                ]
+        }
+      },
+      {
+        displayName: "Personal Data (PII)",
+        name: "pii",
+        type: "fixedCollection",
+        default: { value: { type: "all" } },
+        description: "Detects attempts to use personal data content",
+        options: [
+          wrapValue([
+            {
+              displayName: "Type",
+              name: "type",
+              type: "options",
+              default: "",
+              options: [
+                { name: "All", value: "all" },
+                { name: "Selected", value: "selected" }
+              ]
+            },
+            {
+              displayName: "Entities",
+              name: "entities",
+              type: "multiOptions",
+              default: [],
+              displayOptions: {
+                show: {
+                  type: ["selected"]
+                }
               },
-              {
-                displayName: "Entities",
-                name: "entities",
-                type: "multiOptions",
-                default: [],
-                displayOptions: {
-                  show: {
-                    type: ["selected"]
-                  }
+              options: Object.values(import_pii.PIIEntity).map((entity) => ({
+                name: import_pii.PII_NAME_MAP[entity],
+                value: entity
+              }))
+            }
+          ])
+        ]
+      },
+      {
+        displayName: "Secret Keys",
+        name: "secretKeys",
+        type: "fixedCollection",
+        default: { value: { permissiveness: "balanced" } },
+        description: "Detects attempts to use secret keys in the input text. Scans text for common patterns, applies entropy analysis to detect random-looking strings.",
+        options: [
+          wrapValue([
+            {
+              displayName: "Permissiveness",
+              name: "permissiveness",
+              type: "options",
+              default: "",
+              options: [
+                {
+                  name: "Strict",
+                  value: "strict",
+                  description: "Most sensitive, may have more false positives (commonly flag high entropy filenames or code)"
+                },
+                {
+                  name: "Balanced",
+                  value: "balanced",
+                  description: "Balanced between sensitivity and specificity"
                 },
-                options: Object.values(import_pii.PIIEntity).map((entity) => ({
-                  name: import_pii.PII_NAME_MAP[entity],
-                  value: entity
-                }))
+                {
+                  name: "Permissive",
+                  value: "permissive",
+                  description: "Least sensitive, may miss some secret keys (but also reduces false positives)"
+                }
+              ]
+            }
+          ])
+        ]
+      },
+      {
+        displayName: "Topical Alignment",
+        name: "topicalAlignment",
+        type: "fixedCollection",
+        default: { value: { threshold: 0.7 } },
+        description: "Detects attempts to stray from the business scope",
+        options: [
+          wrapValue([
+            THRESHOLD_OPTION,
+            ...getPromptOption(
+              import_topicalAlignment.TOPICAL_ALIGNMENT_SYSTEM_PROMPT,
+              false,
+              "Make sure you replace the placeholder."
+            )
+          ])
+        ],
+        displayOptions: {
+          show: {
+            "/operation": ["classify"]
+          }
+        }
+      },
+      {
+        displayName: "URLs",
+        name: "urls",
+        type: "fixedCollection",
+        default: { value: { allowedSchemes: ["https"], allowedUrls: "" } },
+        description: "Blocks URLs that are not in the allowed list",
+        options: [
+          wrapValue([
+            {
+              displayName: "Block All URLs Except",
+              name: "allowedUrls",
+              type: "string",
+              // keep placeholder to avoid limitation that removes collections with unchanged default values
+              default: "PLACEHOLDER",
+              description: "Multiple URLs can be added separated by comma. Leave empty to block all URLs."
+            },
+            {
+              displayName: "Allowed Schemes",
+              name: "allowedSchemes",
+              type: "multiOptions",
+              default: ["https"],
+              // eslint-disable-next-line n8n-nodes-base/node-param-multi-options-type-unsorted-items
+              options: [
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "https", value: "https" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "http", value: "http" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "ftp", value: "ftp" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "data", value: "data" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "javascript", value: "javascript" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "vbscript", value: "vbscript" },
+                // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
+                { name: "mailto", value: "mailto" }
+              ]
+            },
+            {
+              displayName: "Block Userinfo",
+              name: "blockUserinfo",
+              type: "boolean",
+              default: true,
+              description: "Whether to block URLs with userinfo (user:pass@domain) to prevent credential injection",
+              displayOptions: {
+                show: {
+                  "/operation": ["classify"]
+                }
+              }
+            },
+            {
+              displayName: "Sanitize Userinfo",
+              name: "blockUserinfo",
+              type: "boolean",
+              default: true,
+              description: "Whether to sanitize URLs with userinfo (user:pass@domain) to prevent credential injection",
+              displayOptions: {
+                show: {
+                  "/operation": ["sanitize"]
+                }
               }
-            ])
-          ]
+            },
+            {
+              displayName: "Allow Subdomains",
+              name: "allowSubdomains",
+              type: "boolean",
+              default: true,
+              description: "Whether to allow subdomains (e.g. sub.domain.com if domain.com is allowed)"
+            }
+          ])
+        ]
+      },
+      {
+        displayName: "Custom",
+        name: "custom",
+        type: "fixedCollection",
+        typeOptions: {
+          sortable: true,
+          multipleValues: true
         },
-        {
-          displayName: "Secret Keys",
-          name: "secretKeys",
-          type: "fixedCollection",
-          default: { value: { permissiveness: "balanced" } },
-          description: "Detects attempts to use secret keys in the input text. Scans text for common patterns, applies entropy analysis to detect random-looking strings.",
-          options: [
-            wrapValue([
+        placeholder: "Add Custom Guardrail",
+        default: {
+          guardrail: [{ name: "Custom Guardrail" }]
+        },
+        options: [
+          {
+            displayName: "Guardrail",
+            name: "guardrail",
+            values: [
               {
-                displayName: "Permissiveness",
-                name: "permissiveness",
-                type: "options",
+                displayName: "Name",
+                name: "name",
+                type: "string",
                 default: "",
-                options: [
-                  {
-                    name: "Strict",
-                    value: "strict",
-                    description: "Most sensitive, may have more false positives (commonly flag high entropy filenames or code)"
-                  },
-                  {
-                    name: "Balanced",
-                    value: "balanced",
-                    description: "Balanced between sensitivity and specificity"
-                  },
-                  {
-                    name: "Permissive",
-                    value: "permissive",
-                    description: "Least sensitive, may miss some secret keys (but also reduces false positives)"
-                  }
-                ]
-              }
-            ])
-          ]
-        },
-        {
-          displayName: "Topical Alignment",
-          name: "topicalAlignment",
-          type: "fixedCollection",
-          default: { value: { threshold: 0.7 } },
-          description: "Detects attempts to stray from the business scope",
-          options: [
-            wrapValue([
+                description: "Name of the custom guardrail"
+              },
               THRESHOLD_OPTION,
-              ...getPromptOption(
-                import_topicalAlignment.TOPICAL_ALIGNMENT_SYSTEM_PROMPT,
-                false,
-                "Make sure you replace the placeholder."
-              )
-            ])
-          ],
-          displayOptions: {
-            show: {
-              "/operation": ["classify"]
-            }
+              ...getPromptOption("", false)
+            ]
+          }
+        ],
+        displayOptions: {
+          show: {
+            "/operation": ["classify"]
           }
+        }
+      },
+      {
+        displayName: "Custom Regex",
+        name: "customRegex",
+        type: "fixedCollection",
+        typeOptions: {
+          sortable: true,
+          multipleValues: true
         },
-        {
-          displayName: "URLs",
-          name: "urls",
-          type: "fixedCollection",
-          default: { value: { allowedSchemes: ["https"], allowedUrls: "" } },
-          description: "Blocks URLs that are not in the allowed list",
-          options: [
-            wrapValue([
+        placeholder: "Add Custom Regex",
+        default: {},
+        options: [
+          {
+            displayName: "Regex",
+            name: "regex",
+            values: [
               {
-                displayName: "Block All URLs Except",
-                name: "allowedUrls",
+                displayName: "Name",
+                name: "name",
                 type: "string",
-                // keep placeholder to avoid limitation that removes collections with unchanged default values
-                default: "PLACEHOLDER",
-                description: "Multiple URLs can be added separated by comma. Leave empty to block all URLs."
-              },
-              {
-                displayName: "Allowed Schemes",
-                name: "allowedSchemes",
-                type: "multiOptions",
-                default: ["https"],
-                // eslint-disable-next-line n8n-nodes-base/node-param-multi-options-type-unsorted-items
-                options: [
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "https", value: "https" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "http", value: "http" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "ftp", value: "ftp" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "data", value: "data" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "javascript", value: "javascript" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "vbscript", value: "vbscript" },
-                  // eslint-disable-next-line n8n-nodes-base/node-param-display-name-miscased
-                  { name: "mailto", value: "mailto" }
-                ]
-              },
-              {
-                displayName: "Block Userinfo",
-                name: "blockUserinfo",
-                type: "boolean",
-                default: true,
-                description: "Whether to block URLs with userinfo (user:pass@domain) to prevent credential injection",
-                displayOptions: {
-                  show: {
-                    "/operation": ["classify"]
-                  }
-                }
-              },
-              {
-                displayName: "Sanitize Userinfo",
-                name: "blockUserinfo",
-                type: "boolean",
-                default: true,
-                description: "Whether to sanitize URLs with userinfo (user:pass@domain) to prevent credential injection",
-                displayOptions: {
-                  show: {
-                    "/operation": ["sanitize"]
-                  }
-                }
+                default: "",
+                description: "Name of the custom regex. Will be used for replacement when sanitizing."
               },
               {
-                displayName: "Allow Subdomains",
-                name: "allowSubdomains",
-                type: "boolean",
-                default: true,
-                description: "Whether to allow subdomains (e.g. sub.domain.com if domain.com is allowed)"
+                displayName: "Regex",
+                name: "value",
+                type: "string",
+                default: "",
+                description: "Regex to match the input text",
+                placeholder: "/text/gi"
               }
-            ])
-          ]
-        },
-        {
-          displayName: "Custom",
-          name: "custom",
-          type: "fixedCollection",
-          typeOptions: {
-            sortable: true,
-            multipleValues: true
-          },
-          placeholder: "Add Custom Guardrail",
-          default: {
-            guardrail: [{ name: "Custom Guardrail" }]
-          },
-          options: [
-            {
-              displayName: "Guardrail",
-              name: "guardrail",
-              values: [
-                {
-                  displayName: "Name",
-                  name: "name",
-                  type: "string",
-                  default: "",
-                  description: "Name of the custom guardrail"
-                },
-                THRESHOLD_OPTION,
-                ...getPromptOption("", false)
-              ]
-            }
-          ],
-          displayOptions: {
-            show: {
-              "/operation": ["classify"]
-            }
+            ]
           }
-        },
-        {
-          displayName: "Custom Regex",
-          name: "customRegex",
-          type: "fixedCollection",
-          typeOptions: {
-            sortable: true,
-            multipleValues: true
-          },
-          placeholder: "Add Custom Regex",
-          default: {},
-          options: [
-            {
-              displayName: "Regex",
-              name: "regex",
-              values: [
-                {
-                  displayName: "Name",
-                  name: "name",
-                  type: "string",
-                  default: "",
-                  description: "Name of the custom regex. Will be used for replacement when sanitizing."
-                },
-                {
-                  displayName: "Regex",
-                  name: "value",
-                  type: "string",
-                  default: "",
-                  description: "Regex to match the input text",
-                  placeholder: "/text/gi"
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    },
-    {
-      displayName: "Customize System Message",
-      name: "customizeSystemMessage",
-      description: "Whether to customize the system message used by the guardrail to specify the output format",
-      type: "boolean",
-      default: false,
-      displayOptions: {
-        show: {
-          "/operation": ["classify"]
-        }
+        ]
+      }
+    ]
+  },
+  {
+    displayName: "Customize System Message",
+    name: "customizeSystemMessage",
+    description: "Whether to customize the system message used by the guardrail to specify the output format",
+    type: "boolean",
+    default: false,
+    displayOptions: {
+      show: {
+        "/operation": ["classify"]
       }
+    }
+  },
+  {
+    displayName: "System Message",
+    name: "systemMessage",
+    type: "string",
+    description: "The system message used by the guardrail to enforce thresholds and JSON output according to schema",
+    hint: "This message is appended after prompts defined by guardrails",
+    default: import_model.LLM_SYSTEM_RULES,
+    typeOptions: {
+      rows: 6
     },
-    {
-      displayName: "System Message",
-      name: "systemMessage",
-      type: "string",
-      description: "The system message used by the guardrail to enforce thresholds and JSON output according to schema",
-      hint: "This message is appended after prompts defined by guardrails",
-      default: import_model.LLM_SYSTEM_RULES,
-      typeOptions: {
-        rows: 6
-      },
-      displayOptions: {
-        show: {
-          "/customizeSystemMessage": [true]
-        }
+    displayOptions: {
+      show: {
+        "/customizeSystemMessage": [true]
       }
     }
-  ]
-};
+  }
+];
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  versionDescription
+  propertiesDescription
 });
 //# sourceMappingURL=description.js.map