feat: Add descriptive constant for Azure content filter configuration #485
Conversation
| /** | ||
| * A descriptive constant for Azure content safety filter threshold. | ||
| */ | ||
| export const AzureFilterThreshold = { |
There was a problem hiding this comment.
[q] Does this need to be exported?
[req] Please follow styleguide for reusable const https://github.com/SAP/cloud-sdk-js/blob/main/STYLEGUIDE.md#use-camel-case-for-variable-names-
There was a problem hiding this comment.
I still don't like the naming of the constants, honestly I would vote for using reasonable names instead of this mess, even if it breaks with the other sdks.
There was a problem hiding this comment.
[q] Does this need to be exported?
Yes, because I use it to fetch the corresponding integer value to construct the generated azure content filter type in the filtering convenience function.
[req] Please follow styleguide for reusable const https://github.com/SAP/cloud-sdk-js/blob/main/STYLEGUIDE.md#use-camel-case-for-variable-names-
Renamed it to azureFilterThreshold.
There was a problem hiding this comment.
I still don't like the naming of the constants, honestly I would vote for using reasonable names instead of this mess, even if it breaks with the other sdks.
Launchpad also uses similar threshold levels, and I guess these constants were picked by the other SDK's to also align with launchpad.
So, I would leave this the same for now, although I agree the const names are not very intuitive.
…ive-const-content-filter # Conflicts: # packages/orchestration/README.md # packages/orchestration/src/orchestration-client.test.ts # packages/orchestration/src/orchestration-completion-post-request.test.ts # packages/orchestration/src/util/filtering.test.ts # packages/orchestration/src/util/filtering.ts # packages/orchestration/src/util/request-config.test.ts # sample-code/src/orchestration.ts
KavithaSiva
dismissed
deekshas8’s stale review
Adapted all code review comments.
Co-authored-by: Deeksha Sinha <[email protected]>
|
Is the changelog part of the other PR? Ideally it should be part of this commit. |
I will add it as part of the other PR, as the function gets introduced there, and only a convenience gets added here. |
Context
Closes SAP/ai-sdk-js-backlog#181.
What this PR does and why it is needed
This PR adds self descriptive constants for improving Azure content filter configuration.
Autocompletion works with the string key values of
azureFilterThreshold, the numeric allowed values don't come up in the hints.These constants can only be used in the new convenience function introduced
buildAzureContentSafetyFilter()The old convenience function
buildAzureContentFilter()still allows using numeric values.