Skip to content

Commit a061379

Browse files
committed
April's feedback
1 parent f825fa6 commit a061379

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

articles/ai-foundry/how-to/evaluation-github-action.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: How to run evaluation in GitHub Action to streamline the evaluation
55
manager: scottpolly
66
ms.service: azure-ai-foundry
77
ms.topic: how-to
8-
ms.date: 05/28/2025
8+
ms.date: 06/1/2025
99
ms.reviewer: hanch
1010
ms.author: lagayhar
1111
author: lgayhardt
@@ -47,11 +47,11 @@ The input of ai-agent-evals includes:
4747

4848
# [Foundry project](#tab/foundry-project)
4949

50-
- `azure-ai-project-endpoint`: The endpoint of the Azure AI project. This is used to connect to Azure OpenAI to simulate conversations with each agent, and to connect to the Azure AI evaluation SDK to perform the evaluation.
50+
- `azure-ai-project-endpoint`: The endpoint of the Azure AI project. This is used to connect to your AI project to simulate conversations with each agent, and to connect to the Azure AI evaluation SDK to perform the evaluation.
5151

5252
# [Hub based project](#tab/hub-project)
5353

54-
- `azure-aiproject-connection-string`: The connection string of the Azure AI project. This is used to connect to Azure OpenAI to simulate conversations with each agent, and to connect to the Azure AI evaluation SDK to perform the evaluation.
54+
- `azure-aiproject-connection-string`: The connection string of the Azure AI project. This is used to connect to your AI project to simulate conversations with each agent, and to connect to the Azure AI evaluation SDK to perform the evaluation.
5555

5656
---
5757
- `deployment-name`: the deployed model name for evaluation judgement.
@@ -96,20 +96,52 @@ Here's a sample of the dataset:
9696

9797
To use the GitHub Action, add the GitHub Action to your CI/CD workflows and specify the trigger criteria (for example, on commit) and file paths to trigger your automated workflows.
9898

99+
> [!TIP]
100+
> To minimize costs, you should avoid running evaluation on every commit.
101+
102+
This example illustrates how Azure Agent AI Evaluation can be run when comparing different agents with agent IDs.
103+
99104
# [Foundry project](#tab/foundry-project)
100105

101-
Specify v2-beta.
106+
```YAML
107+
name: "AI Agent Evaluation"
102108

103-
# [Hub based project](#tab/hub-project)
109+
on:
110+
workflow_dispatch:
111+
push:
112+
branches:
113+
- main
104114

105-
Specify v1-beta.
115+
permissions:
116+
id-token: write
117+
contents: read
106118

107-
---
119+
jobs:
120+
run-action:
121+
runs-on: ubuntu-latest
122+
steps:
123+
- name: Checkout
124+
uses: actions/checkout@v4
108125

109-
> [!TIP]
110-
> To minimize costs, you should avoid running evaluation on every commit.
126+
- name: Azure login using Federated Credentials
127+
uses: azure/login@v2
128+
with:
129+
client-id: ${{ vars.AZURE_CLIENT_ID }}
130+
tenant-id: ${{ vars.AZURE_TENANT_ID }}
131+
subscription-id: ${{ vars.AZURE_SUBSCRIPTION_ID }}
111132

112-
This example illustrates how Azure Agent AI Evaluation can be run when comparing different agents with agent IDs.
133+
- name: Run Evaluation
134+
uses: microsoft/ai-agent-evals@v2-beta
135+
with:
136+
# Replace placeholders with values for your Azure AI Project
137+
azure-ai-project-endpoint: "<your-ai-project-endpoint>"
138+
deployment-name: "<your-deployment-name>"
139+
agent-ids: "<your-ai-agent-ids>"
140+
data-path: ${{ github.workspace }}/path/to/your/data-file
141+
142+
```
143+
144+
# [Hub based project](#tab/hub-project)
113145

114146
```YAML
115147
name: "AI Agent Evaluation"
@@ -149,6 +181,8 @@ jobs:
149181

150182
```
151183

184+
---
185+
152186
### AI agent evaluations output
153187

154188
Evaluation results are outputted to the summary section for each AI evaluation GitHub Action run under Actions in GitHub.com.

0 commit comments

Comments
 (0)