feat: Support protected_material_code (#1285)

Author: BrigittaK307

.changeset/smooth-showers-throw.md

@@ -0,0 +1,5 @@
+---
+'@sap-ai-sdk/orchestration': minor
+---
+
+[New Functionality] Added support for `protected_material_code` property to `buildAzureContentSafetyFilter()` function for output filter configuration to allow detecting protected code content from known github repositories.

packages/orchestration/src/orchestration-types.ts

@@ -296,7 +296,6 @@ export interface GroundingModule {
     metadata_params?: string[];
   };
 }
-
 /**
  * Represents a filter configuration for the Document Grounding Service.
  */
@@ -361,10 +360,7 @@ export type DpiMaskingConfig = Omit<
   mask_grounding_input?: boolean;
 };
 
-/**
- * Output Parameters for Azure content safety output filter.
- */
-export interface AzureContentSafetyFilterOutputParameters {
+interface AzureContentSafetyFilterBaseParameters {
   /**
    * The filter category for hate content.
    */
@@ -382,16 +378,27 @@ export interface AzureContentSafetyFilterOutputParameters {
    */
   violence?: AzureFilterThreshold;
 }
+
+/**
+ * Output Parameters for Azure content safety output filter.
+ */
+export interface AzureContentSafetyFilterOutputParameters
+  extends AzureContentSafetyFilterBaseParameters {
+  /**
+   * Detect protected code content from known GitHub repositories. The scan includes software libraries, source code, algorithms, and other proprietary programming content.
+   */
+  protected_material_code?: boolean;
+}
 /**
  * Input parameters for Azure content safety input filter.
  */
-export type AzureContentSafetyFilterInputParameters =
-  AzureContentSafetyFilterOutputParameters & {
-    /**
-     * A flag to use prompt shield.
-     */
-    prompt_shield?: boolean;
-  };
+export interface AzureContentSafetyFilterInputParameters
+  extends AzureContentSafetyFilterBaseParameters {
+  /**
+   * A flag to use prompt shield.
+   */
+  prompt_shield?: boolean;
+}
 
 /**
  * A descriptive constant for Azure content safety filter threshold.

packages/orchestration/src/util/filtering.test.ts

@@ -33,6 +33,21 @@ describe('Content filter util', () => {
         'Filtering parameters cannot be empty'
       );
     });
+
+    it('builds output filter config with protected_material_code', async () => {
+      const filterConfig = buildAzureContentSafetyFilter('output', {
+        hate: 'ALLOW_SAFE',
+        protected_material_code: true
+      });
+      const expectedFilterConfig = {
+        type: 'azure_content_safety',
+        config: {
+          hate: 0,
+          protected_material_code: true
+        }
+      };
+      expect(filterConfig).toEqual(expectedFilterConfig);
+    });
   });
 
   describe('Llama Guard filter', () => {

packages/orchestration/src/util/filtering.ts

@@ -47,15 +47,18 @@ export function buildAzureContentSafetyFilter<T extends ConfigType>(
     } as AzureContentSafetyFilterReturnType<T>;
   }
 
+  const { protected_material_code, ...restConfig } =
+    config as AzureContentSafetyFilterParameters<'output'>;
   return {
     type: 'azure_content_safety',
     config: {
       ...Object.fromEntries(
-        Object.entries(config).map(([key, value]) => [
+        Object.entries(restConfig).map(([key, value]) => [
           key,
           supportedAzureFilterThresholds[value as AzureFilterThreshold]
         ])
-      )
+      ),
+      ...(protected_material_code !== undefined && { protected_material_code })
     }
   } as AzureContentSafetyFilterReturnType<T>;
 }

tests/type-tests/test/orchestration.test-d.ts

@@ -417,6 +417,20 @@ expectError<AzureContentSafetyFilterReturnType<'output'>>(
   })
 );
 
+expectType<AzureContentSafetyFilterReturnType<'output'>>(
+  buildAzureContentSafetyFilter('output', {
+    hate: 'ALLOW_SAFE',
+    protected_material_code: true
+  })
+);
+
+expectError<AzureContentSafetyFilterReturnType<'input'>>(
+  buildAzureContentSafetyFilter('input', {
+    hate: 'ALLOW_SAFE',
+    protected_material_code: true
+  })
+);
+
 /**
  * Filtering Util for Llama guard.
  */