merge from main

.changeset/bright-trees-grow.md

@@ -0,0 +1,5 @@
+---
+'@sap-ai-sdk/orchestration': minor
+---
+
+[New Functionality] Add support for the data masking capabilities of the orchestration service.

packages/orchestration/README.md

@@ -164,6 +164,42 @@ try {
 The Azure content filter supports four categories: `Hate`, `Violence`, `Sexual`, and `SelfHarm`.
 Each category can be configured with severity levels of 0, 2, 4, or 6.
 
+#### Data Masking
+
+You can anonymize or pseudonomize the prompt using the data masking capabilities of the orchestration service.
+
+```ts
+const orchestrationClient = new OrchestrationClient({
+  llm: {
+    model_name: 'gpt-4-32k',
+    model_params: {}
+  },
+  templating: {
+    template: [
+      {
+        role: 'user',
+        content:
+          'Please write an email to {{?user}} ({{?email}}), informing them about the amazing capabilities of generative AI! Be brief and concise, write at most 6 sentences.'
+      }
+    ]
+  },
+  masking: {
+    masking_providers: [
+      {
+        type: 'sap_data_privacy_integration',
+        method: 'pseudonymization',
+        entities: [{ type: 'profile-email' }, { type: 'profile-person' }]
+      }
+    ]
+  }
+});
+
+const response = await orchestrationClient.chatCompletion({
+  inputParams: { user: 'Alice Anderson', email: '[email protected]' }
+});
+return response.getContent();
+```
+
 ## Support, Feedback, Contribution
 
 Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](https://github.com/SAP/ai-sdk-js/blob/main/CONTRIBUTING.md).

packages/orchestration/src/orchestration-client.ts

@@ -65,6 +65,9 @@ export function constructCompletionPostRequest(
         llm_module_config: config.llm,
         ...(Object.keys(config?.filtering || {}).length && {
           filtering_module_config: config.filtering
+        }),
+        ...(Object.keys(config?.masking || {}).length && {
+          masking_module_config: config.masking
         })
       }
     },

packages/orchestration/src/orchestration-types.ts

@@ -2,6 +2,7 @@ import { ChatModel } from './model-types.js';
 import {
   ChatMessages,
   FilteringModuleConfig,
+  MaskingModuleConfig,
   LlmModuleConfig as OriginalLlmModuleConfig,
   TemplatingModuleConfig
 } from './client/api/schema/index.js';
@@ -45,4 +46,8 @@ export interface OrchestrationModuleConfig {
    * Filtering module configuration.
    */
   filtering?: FilteringModuleConfig;
+  /**
+   * Masking module configuration.
+   */
+  masking?: MaskingModuleConfig;
 }

sample-code/src/index.ts

@@ -8,7 +8,8 @@ export {
   orchestrationTemplating,
   orchestrationInputFiltering,
   orchestrationOutputFiltering,
-  orchestrationRequestConfig
+  orchestrationRequestConfig,
+  orchestrationCompletionMasking
 } from './orchestration.js';
 export {
   embedQuery,

sample-code/src/orchestration.ts

@@ -149,6 +149,44 @@ export async function orchestrationOutputFiltering(): Promise<OrchestrationRespo
   );
 }
 
+/**
+ * Ask to write an e-mail while masking personal information.
+ * @returns The message content from the orchestration service in the generative AI hub.
+ */
+export async function orchestrationCompletionMasking(): Promise<
+  string | undefined
+> {
+  const orchestrationClient = new OrchestrationClient({
+    llm: {
+      model_name: 'gpt-4-32k',
+      model_params: {}
+    },
+    templating: {
+      template: [
+        {
+          role: 'user',
+          content:
+            'Please write an email to {{?user}} ({{?email}}), informing them about the amazing capabilities of generative AI! Be brief and concise, write at most 6 sentences.'
+        }
+      ]
+    },
+    masking: {
+      masking_providers: [
+        {
+          type: 'sap_data_privacy_integration',
+          method: 'pseudonymization',
+          entities: [{ type: 'profile-email' }, { type: 'profile-person' }]
+        }
+      ]
+    }
+  });
+
+  const response = await orchestrationClient.chatCompletion({
+    inputParams: { user: 'Alice Anderson', email: '[email protected]' }
+  });
+  return response.getContent();
+}
+
 /**
  * Ask about the capital of France and send along custom request configuration.
  * @returns The orchestration service response.

tests/e2e-tests/src/orchestration.test.ts

@@ -3,7 +3,8 @@ import {
   orchestrationTemplating,
   orchestrationInputFiltering,
   orchestrationOutputFiltering,
-  orchestrationRequestConfig
+  orchestrationRequestConfig,
+  orchestrationCompletionMasking
 } from '@sap-ai-sdk/sample-code';
 import { OrchestrationResponse } from '@sap-ai-sdk/orchestration';
 import { loadEnv } from './utils/load-env.js';
@@ -49,4 +50,9 @@ describe('orchestration', () => {
 
     assertContent(response);
   });
+
+  it('should complete a chat with masking', async () => {
+    const result = await orchestrationCompletionMasking();
+    expect(result).toEqual(expect.any(String));
+  });
 });