Merge pull request #986 from Portkey-AI/feat/default-guardrails

feat: add support for default guardrails

Author: VisargD

src/handlers/handlerUtils.ts

@@ -283,8 +283,14 @@ export async function tryPost(
     metadata,
     provider,
     isStreamingMode,
-    providerOption.beforeRequestHooks || [],
-    providerOption.afterRequestHooks || [],
+    [
+      ...(providerOption.beforeRequestHooks || []),
+      ...(providerOption.defaultInputGuardrails || []),
+    ],
+    [
+      ...(providerOption.afterRequestHooks || []),
+      ...(providerOption.defaultOutputGuardrails || []),
+    ],
     null,
     fn
   );
@@ -586,8 +592,33 @@ export async function tryTargetsRecursively(
       ? { ...currentTarget.cache }
       : { ...inheritedConfig.cache },
     requestTimeout: null,
+    defaultInputGuardrails: inheritedConfig.defaultInputGuardrails,
+    defaultOutputGuardrails: inheritedConfig.defaultOutputGuardrails,
   };
 
+  // Inherited config can be empty only for the base case of recursive call.
+  // To avoid redundant conversion of guardrails to hooks, we do this check.
+  if (Object.keys(inheritedConfig).length === 0) {
+    if (currentTarget.defaultInputGuardrails) {
+      currentInheritedConfig.defaultInputGuardrails = [
+        ...convertHooksShorthand(
+          currentTarget.defaultInputGuardrails,
+          'input',
+          HookType.GUARDRAIL
+        ),
+      ];
+    }
+    if (currentTarget.defaultOutputGuardrails) {
+      currentInheritedConfig.defaultOutputGuardrails = [
+        ...convertHooksShorthand(
+          currentTarget.defaultOutputGuardrails,
+          'output',
+          HookType.GUARDRAIL
+        ),
+      ];
+    }
+  }
+
   if (typeof currentTarget.strictOpenAiCompliance === 'boolean') {
     currentInheritedConfig.strictOpenAiCompliance =
       currentTarget.strictOpenAiCompliance;
@@ -694,6 +725,13 @@ export async function tryTargetsRecursively(
   currentTarget.cache = {
     ...currentInheritedConfig.cache,
   };
+
+  currentTarget.defaultInputGuardrails = [
+    ...currentInheritedConfig.defaultInputGuardrails,
+  ];
+  currentTarget.defaultOutputGuardrails = [
+    ...currentInheritedConfig.defaultOutputGuardrails,
+  ];
   // end: merge inherited config with current target config (preference given to current)
 
   let response;
@@ -1034,8 +1072,20 @@ export function constructConfigFromRequestHeaders(
     }
   }
 
+  const defaultsConfig = {
+    input_guardrails: requestHeaders[`x-portkey-default-input-guardrails`]
+      ? JSON.parse(requestHeaders[`x-portkey-default-input-guardrails`])
+      : [],
+    output_guardrails: requestHeaders[`x-portkey-default-output-guardrails`]
+      ? JSON.parse(requestHeaders[`x-portkey-default-output-guardrails`])
+      : [],
+  };
+
   if (requestHeaders[`x-${POWERED_BY}-config`]) {
     let parsedConfigJson = JSON.parse(requestHeaders[`x-${POWERED_BY}-config`]);
+    parsedConfigJson.default_input_guardrails = defaultsConfig.input_guardrails;
+    parsedConfigJson.default_output_guardrails =
+      defaultsConfig.output_guardrails;
 
     if (!parsedConfigJson.provider && !parsedConfigJson.targets) {
       parsedConfigJson.provider = requestHeaders[`x-${POWERED_BY}-provider`];
@@ -1131,12 +1181,16 @@ export function constructConfigFromRequestHeaders(
       'conditions',
       'input_guardrails',
       'output_guardrails',
+      'default_input_guardrails',
+      'default_output_guardrails',
     ]) as any;
   }
 
   return {
     provider: requestHeaders[`x-${POWERED_BY}-provider`],
     apiKey: requestHeaders['authorization']?.replace('Bearer ', ''),
+    defaultInputGuardrails: defaultsConfig.input_guardrails,
+    defaultOutputGuardrails: defaultsConfig.output_guardrails,
     ...(requestHeaders[`x-${POWERED_BY}-provider`] === AZURE_OPEN_AI &&
       azureConfig),
     ...([BEDROCK, SAGEMAKER].includes(

src/types/requestBody.ts

@@ -124,6 +124,9 @@ export interface Options {
 
   afterRequestHooks?: HookObject[];
   beforeRequestHooks?: HookObject[];
+  defaultInputGuardrails?: HookObject[];
+  defaultOutputGuardrails?: HookObject[];
+
   /** OpenAI specific */
   openaiProject?: string;
   openaiOrganization?: string;
@@ -188,6 +191,9 @@ export interface Targets {
 
   /** This is used to determine if the request should be transformed to formData Example: Stability V2 */
   transformToFormData?: boolean;
+
+  defaultInputGuardrails?: HookObject[];
+  defaultOutputGuardrails?: HookObject[];
 }
 
 /**