-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Python: Use AI Foundry evaluators for self-reflection #2250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
646485b
First working version
YusakuNo1 bbe6eb4
Simplify the implementations
YusakuNo1 30f08a3
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 03999bc
Remove unused env var
YusakuNo1 387ba9b
Update Python syntax
YusakuNo1 70e25be
Address feedbacks
YusakuNo1 4a103be
Fix a typo
YusakuNo1 f605133
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 2e0b758
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 14ca874
Update names as review suggestions
YusakuNo1 c65edba
Citation for self-reflection
YusakuNo1 a0f9479
Merge branch 'users/daviwu/self_reflection' of github.com:microsoft/a…
YusakuNo1 a691d8e
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 165fdde
Move to independent folder
YusakuNo1 3d8be84
Update python/samples/getting_started/evaluation/azure_ai_foundry/eva…
YusakuNo1 e189301
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 1bde318
Updated from parquet to JSONL and hide the default environment variables
YusakuNo1 fff8ff0
As review feedback, remove the purpose of using `run_self_reflection_…
YusakuNo1 d47d336
Merge branch 'users/daviwu/self_reflection' of github.com:microsoft/a…
YusakuNo1 9f1ffe2
Update python/samples/getting_started/evaluation/azure_ai_foundry/eva…
YusakuNo1 04c7bce
Merge branch 'main' into users/daviwu/self_reflection
YusakuNo1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
2 changes: 2 additions & 0 deletions
2
python/samples/getting_started/evaluation/azure_ai_foundry/evaluation/.env.example
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| AZURE_OPENAI_ENDPOINT="..." | ||
| AZURE_OPENAI_API_KEY="..." |
75 changes: 75 additions & 0 deletions
75
python/samples/getting_started/evaluation/azure_ai_foundry/evaluation/README.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Self-Reflection Evaluation Sample | ||
|
|
||
| This sample demonstrates the self-reflection pattern using Agent Framework and Azure AI Foundry's Groundedness Evaluator. For details, see [Reflexion: Language Agents with Verbal Reinforcement Learning](https://arxiv.org/abs/2303.11366) (NeurIPS 2023). | ||
|
|
||
| ## Overview | ||
|
|
||
| **What it demonstrates:** | ||
| - Iterative self-reflection loop that automatically improves responses based on groundedness evaluation | ||
| - Batch processing of prompts from Parquet files with progress tracking | ||
| - Using `AzureOpenAIChatClient` with Azure CLI authentication | ||
| - Comprehensive summary statistics and detailed result tracking | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Azure Resources | ||
| - **Azure OpenAI**: Deploy models (default: gpt-4.1 for both agent and judge) | ||
| - **Azure CLI**: Run `az login` to authenticate | ||
|
|
||
| ### Python Environment | ||
| ```bash | ||
| pip install agent-framework-core azure-ai-evaluation pandas --pre | ||
| ``` | ||
|
|
||
| ### Environment Variables | ||
| ```bash | ||
| # .env file | ||
| AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com/ | ||
| AZURE_OPENAI_API_KEY=your-api-key # Optional with Azure CLI | ||
| ``` | ||
|
|
||
| ## Running the Sample | ||
|
|
||
| ```bash | ||
| # Basic usage | ||
| python self_reflection.py | ||
|
|
||
| # With options | ||
| python self_reflection.py --input my_prompts.parquet \ | ||
| --output results.parquet \ | ||
| --max-reflections 5 \ | ||
| -n 10 | ||
| ``` | ||
|
|
||
| **CLI Options:** | ||
| - `--input`, `-i`: Input parquet file | ||
| - `--output`, `-o`: Output parquet file | ||
| - `--agent-model`, `-m`: Agent model name (default: gpt-4.1) | ||
| - `--judge-model`, `-e`: Evaluator model name (default: gpt-4.1) | ||
| - `--max-reflections`: Max iterations (default: 3) | ||
| - `--limit`, `-n`: Process only first N prompts | ||
|
|
||
| ## Understanding Results | ||
|
|
||
| The agent iteratively improves responses: | ||
| 1. Generate initial response | ||
| 2. Evaluate groundedness (1-5 scale) | ||
| 3. If score < 5, provide feedback and retry | ||
| 4. Stop at max iterations or perfect score (5/5) | ||
|
|
||
| **Example output:** | ||
| ``` | ||
| [1/31] Processing prompt 0... | ||
| Self-reflection iteration 1/3... | ||
| Groundedness score: 3/5 | ||
| Self-reflection iteration 2/3... | ||
| Groundedness score: 5/5 | ||
| ✓ Perfect groundedness score achieved! | ||
| ✓ Completed with score: 5/5 (best at iteration 2/3) | ||
| ``` | ||
|
|
||
| ## Related Resources | ||
|
|
||
| - [Reflexion Paper](https://arxiv.org/abs/2303.11366) | ||
| - [Azure AI Evaluation SDK](https://learn.microsoft.com/azure/ai-studio/how-to/develop/evaluate-sdk) | ||
| - [Agent Framework](https://github.com/microsoft/agent-framework) |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.