[azure-ai-evaluation] Fix broken README/migration code samples, typos, and stale links#48122
Open
kkchandi wants to merge 4 commits into
Open
[azure-ai-evaluation] Fix broken README/migration code samples, typos, and stale links#48122kkchandi wants to merge 4 commits into
kkchandi wants to merge 4 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
…guide Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 77e272d0-4d0f-42cf-b18b-50a5ab5b60e5
|
Azure Pipelines: Successfully started running 1 pipeline(s). 9 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
github-actions
Bot
added
the
Evaluation
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes broken documentation samples, typos, environment variables, links, and terminology in azure-ai-evaluation.
Changes:
- Corrects README sample syntax and variables.
- Updates documentation links and wording.
- Fixes a migration-guide syntax error.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
README.md |
Repairs samples, typos, environment variables, and links. |
migration_guide.md |
Closes an evaluator call. |
TROUBLESHOOTING.md |
Updates hub terminology, but needs current branding. |
| - Before running `evaluate()`, to ensure that you can enable logging and tracing to your Azure AI project, make sure you are first logged in by running `az login`. | ||
|
|
||
| - Ensure that you assign the proper permissions to the storage account linked to your Azure AI Studio hub. This can be done with the following command. More information can be found [here](https://aka.ms/credentialleshub). | ||
| - Ensure that you assign the proper permissions to the storage account linked to your Azure AI Foundry hub. This can be done with the following command. More information can be found [here](https://aka.ms/credentialleshub). |
| ```Shell | ||
| # <mySubscriptionID>: Subscription ID of the Azure AI Studio hub's linked storage account (available in Azure AI hub resource view in Azure Portal). | ||
| # <myResourceGroupName>: Resource group of the Azure AI Studio hub's linked storage account. | ||
| # <mySubscriptionID>: Subscription ID of the Azure AI Foundry hub's linked storage account (available in Azure AI hub resource view in Azure Portal). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
sdk/evaluation/azure-ai-evaluation/TROUBLESHOOTING.md:31
- This introduces the previous product name rather than the current Microsoft Foundry branding. Current Microsoft Learn classic-hub documentation calls this a “Microsoft Foundry hub,” which line 35 already uses; please keep the terminology consistent.
- Ensure that you assign the proper permissions to the storage account linked to your Azure AI Foundry hub. This can be done with the following command. More information can be found [here](https://aka.ms/credentialleshub).
sdk/evaluation/azure-ai-evaluation/TROUBLESHOOTING.md:34
- This second occurrence also retains the superseded “Azure AI Foundry” name while the adjacent comment uses the current “Microsoft Foundry” branding. Use one current product name throughout this command description.
# <mySubscriptionID>: Subscription ID of the Azure AI Foundry hub's linked storage account (available in Azure AI hub resource view in Azure Portal).
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
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.
Documentation-only fixes in the
azure-ai-evaluationpackage. No code or behavior changes.README.md
BleuScoreEvaluator(bleu_score_evaluator(...)) instead of an undefinedbleu_score(...)(NameError).responseparameter instead of the undefinedanswer.AZURE_OPENAI_ENDPOINT/AZURE_OPENAI_KEY/AZURE_OPENAI_DEPLOYMENT).AZURE_OPENAI_KEY.synthentic->synthetic,intergration->integration.learn.microsoft.com/azure/ai-studio/...links with currentfoundry/foundry-classicpaths.migration_guide.md
ContentSafetyEvaluator(...)call (missing)), which was aSyntaxError.TROUBLESHOOTING.md