Update_Model_Api_Key #41983
Open
Update_Model_Api_Key #41983
+6
−6
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
w-javed
requested review from
dargilco,
jhakulin,
trangevi,
glharper,
nick863 and
howieleung
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR updates the HTTP header key used for passing the API key from "api-key" to "model-api-key" across sample code and documentation.
- Replaces
"api-key"with"model-api-key"in both sync and async samples for red-team and evaluation workflows. - Updates the README sample snippet to reflect the new header name.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sdk/ai/azure-ai-projects/samples/red_team/sample_red_team_async.py | Updated header key to "model-api-key". |
| sdk/ai/azure-ai-projects/samples/red_team/sample_red_team.py | Updated header key to "model-api-key". |
| sdk/ai/azure-ai-projects/samples/evaluation/sample_evaluations_async.py | Updated header key to "model-api-key". |
| sdk/ai/azure-ai-projects/samples/evaluation/sample_evaluations_aoai_graders.py | Updated header key to "model-api-key". |
| sdk/ai/azure-ai-projects/samples/evaluation/sample_evaluations.py | Updated header key to "model-api-key". |
| sdk/ai/azure-ai-projects/README.md | Updated sample code snippet with new header key. |
| @@ -71,7 +71,7 @@ async def sample_red_team_async() -> None: | |||
| red_team=red_team, | |||
| headers={ | |||
| "model-endpoint": model_endpoint, | |||
| "api-key": model_api_key, | |||
| "model-api-key": model_api_key, | |||
There was a problem hiding this comment.
[nitpick] Consider extracting the header key string 'model-api-key' into a shared constant (e.g. MODEL_API_KEY_HEADER) to avoid duplication across samples and minimize the risk of typos.
Suggested change
| "model-api-key": model_api_key, | |
| MODEL_API_KEY_HEADER: model_api_key, |
Copilot uses AI. Check for mistakes.
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.
No description provided.