refactor: Content filter helper function #441
Conversation
| '@sap-ai-sdk/orchestration': minor | ||
| --- | ||
|
|
||
| [Compatibility Note] Deprecate `buildAzureContentFilter()` since it restricts filtering to have only one filter, use `ContentFilters.azure()` instead. |
There was a problem hiding this comment.
| [Compatibility Note] Deprecate `buildAzureContentFilter()` since it restricts filtering to have only one filter, use `ContentFilters.azure()` instead. | |
| [Compatibility Note] Deprecate `buildAzureContentFilter()` function since it restricts filtering to have only one filter. Use `ContentFilters.azure()` instead. |
| } from '@sap-ai-sdk/orchestration'; | ||
| #### Azure Content Filter | ||
|
|
||
| Use `ContentFilters.azure()` to build an Azure content filter. |
There was a problem hiding this comment.
| Use `ContentFilters.azure()` to build an Azure content filter. | |
| Use `ContentFilters.azure()` function to build an Azure content filter. |
Follow style guide
| When the chat completion request fails with a `400` status code, the caught error will be an `Axios` error. | ||
| The property `error.response.data.message` may provide additional details about the failure's cause. | ||
|
|
||
| - **output content filtered**: | ||
| - **Output Content Filtered**: | ||
| The method `getContent()` can throw an error if the output filter filters the model output. |
There was a problem hiding this comment.
| The method `getContent()` can throw an error if the output filter filters the model output. | |
| The `getContent()` method can throw an error if the output filter filters the model output. |
| @@ -1,4 +1,4 @@ | |||
| export * from './orchestration-client.js'; | |||
| export * from './orchestration-utils.js'; | |||
| export * from './orchestration-filtering.js'; | |||
There was a problem hiding this comment.
if we're splitting the grounding and filtering util files, please put them in a separate util folder
| * @param config - Filtering configuration for Azure filter. If skipped, the default Azure content filter configuration is used. | ||
| * @returns Filter config object. | ||
| */ | ||
| function azure(config?: AzureContentSafety): FilterConfig { |
There was a problem hiding this comment.
The return type here should be AzureContentSafetyFilterConfig, no?
|
|
||
| #### Output Filtering | ||
|
|
||
| `GET /orchestration/outputFiltering` | ||
|
|
||
| Get chat completion response with Azure content filter for the output. | ||
| Use `buildAzureContentFilter()` to build the content filter. | ||
| For example, use `ContentFilters.azure()` to build Azure content filter. |
| export { buildAzureContentFilter } from './orchestration-utils.js'; | ||
| export { | ||
| buildAzureContentFilter, | ||
| ContentFilters |
There was a problem hiding this comment.
[req] The azure function should also be exported here.
|
Proposed API looks good to me too, although I didn't like it that the user has to explicitly wrap the calls inside an array even for using a single filter. I feel typing An alternate I could think of was: filtering: {
input: ContentFilters.azure({ Hate: 4, SelfHarm: 0 }),
// or
input: ContentFilters.llamaGuard({ ... }),
// or
input: ContentFilters.addMultipleFilters(
ContentFilters.azure({ Hate: 4, SelfHarm: 0 }),
ContentFilters.llamaGuard({ ... })
)
}WDY think? |
Context
SAP/ai-sdk-js-backlog#202.
What this PR does and why it is needed
Deprecate
buildAzureContentFilter()because it restricts filtering to have only one filter.Implement
ContentFilters.azure(). New filters can be added toContentFiltersconstant.