@sap-ai-sdk/orchestration 1.8.1-20250223013116.0 → 1.8.1-20250225013119.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -17
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/orchestration-types.d.ts +5 -1
- package/dist/orchestration-types.d.ts.map +1 -1
- package/dist/orchestration-types.js.map +1 -1
- package/dist/util/filtering.d.ts +12 -4
- package/dist/util/filtering.d.ts.map +1 -1
- package/dist/util/filtering.js +15 -2
- package/dist/util/filtering.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -336,20 +336,12 @@ Use the orchestration client with filtering to restrict content that is passed t
|
|
|
336
336
|
|
|
337
337
|
This feature allows filtering both the [input](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/input-filtering) and [output](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/output-filtering) of a model based on content safety criteria.
|
|
338
338
|
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
Use `buildAzureContentSafetyFilter()` function to build an Azure content filter for both input and output.
|
|
342
|
-
Each category of the filter can be assigned a specific severity level, which corresponds to an Azure threshold value.
|
|
343
|
-
|
|
344
|
-
| Severity Level | Azure Threshold Value |
|
|
345
|
-
| ----------------------- | --------------------- |
|
|
346
|
-
| `ALLOW_SAFE` | 0 |
|
|
347
|
-
| `ALLOW_SAFE_LOW` | 2 |
|
|
348
|
-
| `ALLOW_SAFE_LOW_MEDIUM` | 4 |
|
|
349
|
-
| `ALLOW_ALL` | 6 |
|
|
339
|
+
The following example demonstrates how to use content filtering with the orchestration client.
|
|
340
|
+
See the sections below for details on the available content filters and how to build them.
|
|
350
341
|
|
|
351
342
|
```ts
|
|
352
|
-
import { OrchestrationClient
|
|
343
|
+
import { OrchestrationClient } from '@sap-ai-sdk/orchestration';
|
|
344
|
+
|
|
353
345
|
const llm = {
|
|
354
346
|
model_name: 'gpt-4o',
|
|
355
347
|
model_params: { max_tokens: 50, temperature: 0.1 }
|
|
@@ -358,16 +350,14 @@ const templating = {
|
|
|
358
350
|
template: [{ role: 'user', content: '{{?input}}' }]
|
|
359
351
|
};
|
|
360
352
|
|
|
361
|
-
const filter =
|
|
362
|
-
|
|
363
|
-
Violence: 'ALLOW_SAFE_LOW_MEDIUM'
|
|
364
|
-
});
|
|
353
|
+
const filter = ... // Use a build function to create a content filter
|
|
354
|
+
|
|
365
355
|
const orchestrationClient = new OrchestrationClient({
|
|
366
356
|
llm,
|
|
367
357
|
templating,
|
|
368
358
|
filtering: {
|
|
369
359
|
input: {
|
|
370
|
-
filters: [filter]
|
|
360
|
+
filters: [filter] // Multiple filters can be applied
|
|
371
361
|
},
|
|
372
362
|
output: {
|
|
373
363
|
filters: [filter]
|
|
@@ -385,6 +375,38 @@ try {
|
|
|
385
375
|
}
|
|
386
376
|
```
|
|
387
377
|
|
|
378
|
+
Multiple filters can be applied at the same time for both input and output filtering.
|
|
379
|
+
|
|
380
|
+
#### Azure Content Filter
|
|
381
|
+
|
|
382
|
+
Use `buildAzureContentSafetyFilter()` function to build an Azure content filter.
|
|
383
|
+
Each category of the filter can be assigned a specific severity level, which corresponds to an Azure threshold value.
|
|
384
|
+
|
|
385
|
+
| Severity Level | Azure Threshold Value |
|
|
386
|
+
| ----------------------- | --------------------- |
|
|
387
|
+
| `ALLOW_SAFE` | 0 |
|
|
388
|
+
| `ALLOW_SAFE_LOW` | 2 |
|
|
389
|
+
| `ALLOW_SAFE_LOW_MEDIUM` | 4 |
|
|
390
|
+
| `ALLOW_ALL` | 6 |
|
|
391
|
+
|
|
392
|
+
```ts
|
|
393
|
+
const filter = buildAzureContentSafetyFilter({
|
|
394
|
+
Hate: 'ALLOW_SAFE_LOW',
|
|
395
|
+
Violence: 'ALLOW_SAFE_LOW_MEDIUM'
|
|
396
|
+
});
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
#### Llama Guard Filter
|
|
400
|
+
|
|
401
|
+
Use `buildLlamaGuardFilter()` function to build a Llama Guard content filter.
|
|
402
|
+
|
|
403
|
+
Available categories can be found with autocompletion.
|
|
404
|
+
Pass the categories as arguments to the function to enable them.
|
|
405
|
+
|
|
406
|
+
```ts
|
|
407
|
+
const filter = buildLlamaGuardFilter('hate', 'violent_crimes');
|
|
408
|
+
```
|
|
409
|
+
|
|
388
410
|
#### Error Handling
|
|
389
411
|
|
|
390
412
|
Both `chatCompletion()` and `getContent()` methods can throw errors.
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export * from './client/api/schema/index.js';
|
|
2
|
-
export type { OrchestrationModuleConfig, LlmModuleConfig, Prompt, RequestOptions, StreamOptions, DocumentGroundingServiceConfig, DocumentGroundingServiceFilter, LlmModelParams, AzureContentFilter, AzureFilterThreshold } from './orchestration-types.js';
|
|
2
|
+
export type { OrchestrationModuleConfig, LlmModuleConfig, Prompt, RequestOptions, StreamOptions, DocumentGroundingServiceConfig, DocumentGroundingServiceFilter, LlmModelParams, LlamaGuardCategory, AzureContentFilter, AzureFilterThreshold } from './orchestration-types.js';
|
|
3
3
|
export { OrchestrationStreamResponse } from './orchestration-stream-response.js';
|
|
4
4
|
export { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
|
|
5
5
|
export { OrchestrationStream } from './orchestration-stream.js';
|
|
6
6
|
export { OrchestrationClient } from './orchestration-client.js';
|
|
7
|
-
export { buildAzureContentFilter, buildAzureContentSafetyFilter, buildDocumentGroundingConfig } from './util/index.js';
|
|
7
|
+
export { buildAzureContentFilter, buildAzureContentSafetyFilter, buildLlamaGuardFilter, buildDocumentGroundingConfig } from './util/index.js';
|
|
8
8
|
export { OrchestrationResponse } from './orchestration-response.js';
|
|
9
9
|
export type { ChatModel } from './model-types.js';
|
|
10
10
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAE7C,YAAY,EACV,yBAAyB,EACzB,eAAe,EACf,MAAM,EACN,cAAc,EACd,aAAa,EACb,8BAA8B,EAC9B,8BAA8B,EAC9B,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC7B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAE7C,YAAY,EACV,yBAAyB,EACzB,eAAe,EACf,MAAM,EACN,cAAc,EACd,aAAa,EACb,8BAA8B,EAC9B,8BAA8B,EAC9B,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -3,6 +3,6 @@ export { OrchestrationStreamResponse } from './orchestration-stream-response.js'
|
|
|
3
3
|
export { OrchestrationStreamChunkResponse } from './orchestration-stream-chunk-response.js';
|
|
4
4
|
export { OrchestrationStream } from './orchestration-stream.js';
|
|
5
5
|
export { OrchestrationClient } from './orchestration-client.js';
|
|
6
|
-
export { buildAzureContentFilter, buildAzureContentSafetyFilter, buildDocumentGroundingConfig } from './util/index.js';
|
|
6
|
+
export { buildAzureContentFilter, buildAzureContentSafetyFilter, buildLlamaGuardFilter, buildDocumentGroundingConfig } from './util/index.js';
|
|
7
7
|
export { OrchestrationResponse } from './orchestration-response.js';
|
|
8
8
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC;AAgB7C,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAE5F,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { CustomRequestConfig } from '@sap-cloud-sdk/http-client';
|
|
2
2
|
import type { ChatModel } from './model-types.js';
|
|
3
|
-
import type { ChatMessages, DataRepositoryType, DocumentGroundingFilter, FilteringModuleConfig, FilteringStreamOptions, GlobalStreamOptions, GroundingModuleConfig, MaskingModuleConfig, LlmModuleConfig as OriginalLlmModuleConfig, TemplatingModuleConfig } from './client/api/schema/index.js';
|
|
3
|
+
import type { ChatMessages, DataRepositoryType, DocumentGroundingFilter, FilteringModuleConfig, FilteringStreamOptions, GlobalStreamOptions, GroundingModuleConfig, LlamaGuard38B, MaskingModuleConfig, LlmModuleConfig as OriginalLlmModuleConfig, TemplatingModuleConfig } from './client/api/schema/index.js';
|
|
4
4
|
/**
|
|
5
5
|
* Prompt configuration.
|
|
6
6
|
*/
|
|
@@ -178,4 +178,8 @@ export declare const supportedAzureFilterThresholds: {
|
|
|
178
178
|
*
|
|
179
179
|
*/
|
|
180
180
|
export type AzureFilterThreshold = keyof typeof supportedAzureFilterThresholds;
|
|
181
|
+
/**
|
|
182
|
+
* The filter categories supported for Llama guard filter.
|
|
183
|
+
*/
|
|
184
|
+
export type LlamaGuardCategory = keyof LlamaGuard38B;
|
|
181
185
|
//# sourceMappingURL=orchestration-types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orchestration-types.d.ts","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,IAAI,uBAAuB,EAC1C,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG;IACtD,MAAM;IACN,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IACnC;;OAEG;IACH,GAAG,EAAE,eAAe,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7D;;OAEG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAC/C,uBAAuB,EACvB,sBAAsB,CACvB,GAAG;IACF;;;OAGG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;CAKjC,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,8BAA8B,CAAC"}
|
|
1
|
+
{"version":3,"file":"orchestration-types.d.ts","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EACV,YAAY,EACZ,kBAAkB,EAClB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,eAAe,IAAI,uBAAuB,EAC1C,sBAAsB,EACvB,MAAM,8BAA8B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,eAAe,CAAC,EAAE,YAAY,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,uBAAuB,GAAG;IACtD,MAAM;IACN,UAAU,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,sBAAsB,CAAC;IACnC;;OAEG;IACH,GAAG,EAAE,eAAe,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI,CAAC;IAC7D;;OAEG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,IAAI,CAC/C,uBAAuB,EACvB,sBAAsB,CACvB,GAAG;IACF;;;OAGG;IACH,oBAAoB,CAAC,EAAE,kBAAkB,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAC3C;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;CACjC;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;CAKjC,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,8BAA8B,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,aAAa,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"orchestration-types.js","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"orchestration-types.js","sourceRoot":"","sources":["../src/orchestration-types.ts"],"names":[],"mappings":"AA4LA;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,UAAU,EAAE,CAAC;IACb,cAAc,EAAE,CAAC;IACjB,qBAAqB,EAAE,CAAC;IACxB,SAAS,EAAE,CAAC;CACJ,CAAC"}
|
package/dist/util/filtering.d.ts
CHANGED
|
@@ -1,17 +1,25 @@
|
|
|
1
|
-
import type { AzureContentSafety, AzureContentSafetyFilterConfig, InputFilteringConfig, OutputFilteringConfig } from '../client/api/schema/index.js';
|
|
2
|
-
import type { AzureContentFilter } from '../orchestration-types.js';
|
|
1
|
+
import type { AzureContentSafety, AzureContentSafetyFilterConfig, InputFilteringConfig, LlamaGuard38BFilterConfig, OutputFilteringConfig } from '../client/api/schema/index.js';
|
|
2
|
+
import type { AzureContentFilter, LlamaGuardCategory } from '../orchestration-types.js';
|
|
3
3
|
/**
|
|
4
|
-
* Convenience function to
|
|
4
|
+
* Convenience function to build Azure content filter.
|
|
5
5
|
* @param filter - Filtering configuration for Azure filter. If skipped, the default Azure content filter configuration is used.
|
|
6
6
|
* @returns An object with the Azure filtering configuration.
|
|
7
7
|
* @deprecated Since 1.8.0. Use {@link buildAzureContentSafetyFilter()} instead.
|
|
8
8
|
*/
|
|
9
9
|
export declare function buildAzureContentFilter(filter?: AzureContentSafety): InputFilteringConfig | OutputFilteringConfig;
|
|
10
10
|
/**
|
|
11
|
-
* Convenience function to
|
|
11
|
+
* Convenience function to build Azure content filter.
|
|
12
12
|
* @param config - Configuration for Azure content safety filter.
|
|
13
13
|
* If skipped, the default configuration of `ALLOW_SAFE_LOW` is used for all filter categories.
|
|
14
14
|
* @returns Filter config object.
|
|
15
|
+
* @example "buildAzureContentSafetyFilter({ Hate: 'ALLOW_SAFE', Violence: 'ALLOW_SAFE_LOW_MEDIUM' })"
|
|
15
16
|
*/
|
|
16
17
|
export declare function buildAzureContentSafetyFilter(config?: AzureContentFilter): AzureContentSafetyFilterConfig;
|
|
18
|
+
/**
|
|
19
|
+
* Convenience function to build Llama guard filter.
|
|
20
|
+
* @param categories - Categories to be enabled for filtering. Provide at least one category.
|
|
21
|
+
* @returns Filter config object.
|
|
22
|
+
* @example "buildLlamaGuardFilter('self_harm', 'hate')"
|
|
23
|
+
*/
|
|
24
|
+
export declare function buildLlamaGuardFilter(...categories: [LlamaGuardCategory, ...LlamaGuardCategory[]]): LlamaGuard38BFilterConfig;
|
|
17
25
|
//# sourceMappingURL=filtering.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"filtering.d.ts","sourceRoot":"","sources":["../../src/util/filtering.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,kBAAkB,
|
|
1
|
+
{"version":3,"file":"filtering.d.ts","sourceRoot":"","sources":["../../src/util/filtering.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,kBAAkB,EAClB,8BAA8B,EAC9B,oBAAoB,EACpB,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EACV,kBAAkB,EAElB,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AAEnC;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,oBAAoB,GAAG,qBAAqB,CAY9C;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,CAAC,EAAE,kBAAkB,GAC1B,8BAA8B,CAiBhC;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,GAAG,UAAU,EAAE,CAAC,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,CAAC,GAC3D,yBAAyB,CAO3B"}
|
package/dist/util/filtering.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { supportedAzureFilterThresholds } from '../orchestration-types.js';
|
|
2
2
|
/**
|
|
3
|
-
* Convenience function to
|
|
3
|
+
* Convenience function to build Azure content filter.
|
|
4
4
|
* @param filter - Filtering configuration for Azure filter. If skipped, the default Azure content filter configuration is used.
|
|
5
5
|
* @returns An object with the Azure filtering configuration.
|
|
6
6
|
* @deprecated Since 1.8.0. Use {@link buildAzureContentSafetyFilter()} instead.
|
|
@@ -19,10 +19,11 @@ export function buildAzureContentFilter(filter) {
|
|
|
19
19
|
};
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* Convenience function to
|
|
22
|
+
* Convenience function to build Azure content filter.
|
|
23
23
|
* @param config - Configuration for Azure content safety filter.
|
|
24
24
|
* If skipped, the default configuration of `ALLOW_SAFE_LOW` is used for all filter categories.
|
|
25
25
|
* @returns Filter config object.
|
|
26
|
+
* @example "buildAzureContentSafetyFilter({ Hate: 'ALLOW_SAFE', Violence: 'ALLOW_SAFE_LOW_MEDIUM' })"
|
|
26
27
|
*/
|
|
27
28
|
export function buildAzureContentSafetyFilter(config) {
|
|
28
29
|
if (config && !Object.keys(config).length) {
|
|
@@ -40,4 +41,16 @@ export function buildAzureContentSafetyFilter(config) {
|
|
|
40
41
|
})
|
|
41
42
|
};
|
|
42
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Convenience function to build Llama guard filter.
|
|
46
|
+
* @param categories - Categories to be enabled for filtering. Provide at least one category.
|
|
47
|
+
* @returns Filter config object.
|
|
48
|
+
* @example "buildLlamaGuardFilter('self_harm', 'hate')"
|
|
49
|
+
*/
|
|
50
|
+
export function buildLlamaGuardFilter(...categories) {
|
|
51
|
+
return {
|
|
52
|
+
type: 'llama_guard_3_8b',
|
|
53
|
+
config: Object.fromEntries([...categories].map(category => [category, true]))
|
|
54
|
+
};
|
|
55
|
+
}
|
|
43
56
|
//# sourceMappingURL=filtering.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"filtering.js","sourceRoot":"","sources":["../../src/util/filtering.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"filtering.js","sourceRoot":"","sources":["../../src/util/filtering.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAc3E;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAA2B;IAE3B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;aAClC;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAA2B;IAE3B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IACD,OAAO;QACL,IAAI,EAAE,sBAAsB;QAC5B,GAAG,CAAC,MAAM,IAAI;YACZ,MAAM,EAAE;gBACN,GAAG,MAAM,CAAC,WAAW,CACnB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;oBAC3C,GAAG;oBACH,8BAA8B,CAAC,KAA6B,CAAC;iBAC9D,CAAC,CACH;aACF;SACF,CAAC;KACH,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAAG,UAAyD;IAE5D,OAAO;QACL,IAAI,EAAE,kBAAkB;QACxB,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,CAAC,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAClD;KACF,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sap-ai-sdk/orchestration",
|
|
3
|
-
"version": "1.8.1-
|
|
3
|
+
"version": "1.8.1-20250225013119.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"keywords": [
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
],
|
|
22
22
|
"dependencies": {
|
|
23
23
|
"@sap-cloud-sdk/util": "^3.26.1",
|
|
24
|
-
"@sap-ai-sdk/
|
|
25
|
-
"@sap-ai-sdk/
|
|
24
|
+
"@sap-ai-sdk/core": "^1.8.1-20250225013119.0",
|
|
25
|
+
"@sap-ai-sdk/ai-api": "^1.8.1-20250225013119.0"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@sap-cloud-sdk/http-client": "^3.26.1",
|