Updating safety_identifier usage #27
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
steven10a
requested review from
Copilot and
gabor-openai
and removed request for
Copilot
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the safety identifier implementation to use a centralized utility module and conditionally include the parameter only for official OpenAI API clients. The safety identifier value is updated from 'oai-guardrails-ts' to 'openai-guardrails-js' for consistency.
- Extracts safety identifier logic into a reusable utility module with client detection
- Updates the safety identifier string to 'openai-guardrails-js' across all API calls
- Adds conditional logic to exclude the parameter when using Azure OpenAI or third-party providers
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils/safety-identifier.ts | New utility module providing the safety identifier constant and client support detection function |
| src/utils/index.ts | Exports the new safety identifier utilities |
| src/resources/responses/responses.ts | Refactors to use centralized safety identifier with conditional inclusion |
| src/resources/chat/chat.ts | Refactors to use centralized safety identifier with conditional inclusion |
| src/checks/user-defined-llm.ts | Refactors to use centralized safety identifier with conditional inclusion |
| src/checks/moderation.ts | Refactors to use centralized safety identifier with conditional inclusion and improves error handling |
| src/checks/llm-base.ts | Refactors to use centralized safety identifier with conditional inclusion |
| src/tests/unit/utils/safety-identifier.test.ts | Comprehensive test coverage for the new safety identifier utilities |
| src/tests/unit/checks/user-defined-llm.test.ts | Updates test expectations for new safety identifier value |
| src/tests/unit/checks/moderation-secret-keys.test.ts | Updates test expectations for new safety identifier value |
| src/tests/unit/chat-resources.test.ts | Updates test expectations for new safety identifier value |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * Azure OpenAI and local/alternative providers (Ollama, vLLM, etc.) do not. | ||
| * | ||
| * @param client The OpenAI client instance to check | ||
| * @returns True if safety_identifier should be included in API calls, False otherwise |
There was a problem hiding this comment.
Corrected capitalization of 'False' to 'false' for consistency with TypeScript boolean convention.
Suggested change
| * @returns True if safety_identifier should be included in API calls, False otherwise | |
| * @returns true if safety_identifier should be included in API calls, false otherwise |
| try { | ||
| resp = await callModerationAPI(client, data); | ||
| } catch (error) { | ||
|
|
There was a problem hiding this comment.
[nitpick] Empty line inside catch block should be removed to improve code cleanliness.
Suggested change
gabor-openai
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
safety_identifierto only be passed to clients who support it