Skip to content

Commit a4a89b8

Browse files
committed
refactor docs/ folder
1 parent 78f9899 commit a4a89b8

File tree

36 files changed

+352
-113
lines changed

36 files changed

+352
-113
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
mode: agent
3+
---
4+
Define the task to achieve, including specific requirements, constraints, and success criteria.
5+
6+
# Task
7+
8+
1. If the `.vscode` directory does not exist in the root of the repository, create it.
9+
2. Inside the `.vscode` directory, create a file named `mcp.json` if it does not already exist.
10+
3. Populate the `mcp.json` file with the following JSON content:
11+
12+
```json
13+
{
14+
"servers": {
15+
"microsoft.docs.mcp": {
16+
"url": "https://learn.microsoft.com/api/mcp",
17+
"type": "http"
18+
}
19+
},
20+
"inputs": []
21+
}
22+
```

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,4 +418,4 @@ FodyWeavers.xsd
418418
*.msp
419419

420420
#mkdocs static site
421-
site/
421+
site/*

data/Place data for your session into this folder

Whitespace-only changes.

docs/Core-Labs/1-Get-Started/01.md

Lines changed: 90 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,114 @@
11
# 1.1 Provision Infra
22

3+
!!! quote "BY THE END OF THIS LAB YOU SHOULD HAVE"
4+
5+
- [X] Set your tab preference (Instructor-Led or Self-Guided)
6+
- [X] Launched GitHub Codespaces (and setup local environment)
7+
- [X] Provisioned Infrastructure (to get an Azure AI Foundry project)
8+
9+
---
10+
11+
## Before You Begin
12+
13+
These instructions are setup to support both instructor-led training (in-venue, with pre-provisioned subscription) and self-guided learning (at home, with your subscription). The primary difference will be in the initial setup.
14+
15+
**Pick the tab that best represents you right now** ⬇️
16+
17+
=== "Instructor-Led (In Venue)"
18+
19+
!!! info "I am currently in the Microsoft Ignite 2025 Pre-Day Workshop (4h Session)"
20+
21+
=== "Self-Guided (At Home)"
22+
23+
!!! note "I am working through the lab at home, with my subscription (Self-Paced)"
24+
25+
---
26+
27+
<!---
328
We will provision the AZD "Get Started with AI Agents" template as our infrastructure. These notes correspond to [this commit](https://github.com/nitya/get-started-with-ai-agents/commit/c63e1384ae6a295b3d57378fab02ac4227bf835d) on the AZD template repo. My goal is to document the usage and customization of this template to support various projects - as pre-provisioned infrastructure.
29+
-->
30+
31+
## Provision Infrastructure
32+
33+
By the end of this step, you should have an Azure subscription setup with the required resources for this project - which includes an Azure AI Foundry project, AI model deployments, an Azure AI Search service resource - and a default agent with a frontend app.
34+
35+
=== "Instructor-Led (In Venue)"
36+
37+
!!! success "You should have a pre-provisioned Azure subscription - check the [Azure Portal](https://portal.azure.com)"
438

5-
<br/>
39+
=== "Self-Guided (At Home)"
640

7-
## 0. Fork Template & Launch Codespaces
41+
??? task "STEP 1: You need to provision the infrastructure - get the template!"
842

9-
1. Visit the [Get Started With AI Agents](https://github.com/Azure-Samples/get-started-with-ai-agents) repo
10-
1. Fork it to your profile to get a custom copy (.e., [my fork-branch](https://github.com/nitya/get-started-with-ai-agents/tree/sep2025-pdy123-infra))
11-
1. Launch GitHub Codespaces on your fork
12-
1. Wait till the browser VS Code loads - and an active terminal appears.
43+
1. Visit the [Get Started With AI Agents](https://github.com/Azure-Samples/get-started-with-ai-agents) repo
44+
1. Fork it to your profile to get a custom copy (.e., [my fork-branch](https://github.com/nitya/get-started-with-ai-agents/tree/sep2025-pdy123-infra))
45+
1. Launch GitHub Codespaces on your fork
46+
1. Wait till the browser VS Code loads - and an active terminal appears.
1347

14-
_You are ready to deploy the template_
48+
_You are ready to deploy the template_
1549

50+
??? task "STEP 2: You need customize template - setup env variables!"
1651

17-
## 1. Set AZD Env Variables
52+
The azd template can be customized in many ways - the easiest starting point is to use environment variables to customize the resource deployment paramters. Run these commands in the Codespaces terminal. _Note: Pick unique names for the last 2 variables that set the Foundry project and resource names in Azure AI Foundry Portal_
1853

19-
The azd template can be customized in many ways - the easiest starting point is to use environment variables to customize the resource deployment paramters. Run these commands in the Codespaces terminal. _Note: Pick unique names for the last 2 variables that set the Foundry project and resource names in Azure AI Foundry Portal_
54+
```bash
55+
azd env set AZURE_AI_AGENT_DEPLOYMENT_CAPACITY 100
56+
azd env set ENABLE_AZURE_MONITOR_TRACING true
57+
azd env set AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED true
58+
azd env set USE_AZURE_AI_SEARCH_SERVICE true
59+
azd env set USE_APPLICATION_INSIGHTS true
60+
azd env set AZURE_AIPROJECT_NAME nitya-pdy123-aiproj-v1
61+
azd env set AZURE_AISERVICES_NAME nitya-pdy123-aisvcs-v1
62+
```
63+
??? task "STEP 3: You are ready to deploy it - have your Azure subscription ready!"
2064

21-
```bash
22-
azd env set AZURE_AI_AGENT_DEPLOYMENT_CAPACITY 100
23-
azd env set ENABLE_AZURE_MONITOR_TRACING true
24-
azd env set AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED true
25-
azd env set USE_AZURE_AI_SEARCH_SERVICE true
26-
azd env set USE_APPLICATION_INSIGHTS true
27-
azd env set AZURE_AIPROJECT_NAME nitya-pdy123-aiproj-v1
28-
azd env set AZURE_AISERVICES_NAME nitya-pdy123-aisvcs-v1
29-
```
65+
You should already have the Azure Developer CLI (`azd`) tool installed in the GitHub Codespaces environment. Provisioning and deployment is now just a single command:
3066

31-
## 2. Deploy it
67+
```title="" linenums="0"
68+
azd up
69+
```
3270

33-
```bash
34-
azd up
35-
```
71+
Note that we did not have to authenticate beforehand! This command will prompt you to do so, using a device-code workflow that looks something like this:
3672

37-
Note that we did not do any pre-authentication step. So we'll get prompted to login using a device-code workflow like this:
73+
```title="" linenums="0"
74+
? Would you like to log in now? Yes
3875

39-
```bash
40-
? Would you like to log in now? Yes
76+
Start by copying the next code: XXXXXXX
77+
Then press enter and continue to log in from your browser...
78+
```
4179

42-
Start by copying the next code: XXXXXXX
43-
Then press enter and continue to log in from your browser...
44-
```
80+
Next you'll be prompted to select your subscription and the region for deployment. I used `East US2`.
81+
82+
??? task "STEP 4: Wait for the provisioning to complete - it can take 10-15 mins!"
4583

46-
Next you'll be prompted to select your subscription and the region for deployment. I used `East US2`. Then just let the provisioning complete. **This can take 10-15 minutes given our added requirements** - the default (basic) template provisions in 4-6 minutes. _The output looks like this - the first section provisions resources, the second deploys the app_.
84+
You can track the deployments status in the Azure Portal (at the link you will see in your console logs). Wait for the **SUCCESS** message to ensure provisioning is done.
4785

48-
```bash
49-
You can view detailed progress in the Azure Portal:
50-
<url here>
86+
```title="" linenums="0"
87+
You can view detailed progress in the Azure Portal:
88+
<url here>
5189

52-
(✓) Done: Resource group: rg-nitya-pdy123-azd-v1 (447ms)
53-
(✓) Done: Log Analytics workspace: log-vchqcvq7rwoju (22.557s)
54-
(✓) Done: Storage account: stvchqcvq7rwoju (20.675s)
55-
(✓) Done: Application Insights: appi-vchqcvq7rwoju (3.537s)
56-
(✓) Done: Azure AI Services: nitya-pdy123-aisvcs-v1 (1m8.574s)
57-
(✓) Done: Azure AI Services Model Deployment: nitya-pdy123-aisvcs-v1/text-embedding-3-small (1m10.589s)
58-
(✓) Done: Azure AI Services Model Deployment: nitya-pdy123-aisvcs-v1/gpt-4o-mini (1m10.027s)
59-
(✓) Done: Search service: srch-vchqcvq7rwoju (4m50.479s)
60-
(✓) Done: Container Registry: crvchqcvq7rwoju (19.98s)
61-
(✓) Done: Container Apps Environment: containerapps-env-vchqcvq7rwoju (1m24.269s)
62-
(✓) Done: Container App: ca-api-vchqcvq7rwoju (17.742s)
90+
(✓) Done: Resource group: rg-nitya-pdy123-azd-v1 (447ms)
91+
(✓) Done: Log Analytics workspace: log-vchqcvq7rwoju (22.557s)
92+
(✓) Done: Storage account: stvchqcvq7rwoju (20.675s)
93+
(✓) Done: Application Insights: appi-vchqcvq7rwoju (3.537s)
94+
(✓) Done: Azure AI Services: nitya-pdy123-aisvcs-v1 (1m8.574s)
95+
(✓) Done: Azure AI Services Model Deployment: nitya-pdy123-aisvcs-v1/text-embedding-3-small (1m10.589s)
96+
(✓) Done: Azure AI Services Model Deployment: nitya-pdy123-aisvcs-v1/gpt-4o-mini (1m10.027s)
97+
(✓) Done: Search service: srch-vchqcvq7rwoju (4m50.479s)
98+
(✓) Done: Container Registry: crvchqcvq7rwoju (19.98s)
99+
(✓) Done: Container Apps Environment: containerapps-env-vchqcvq7rwoju (1m24.269s)
100+
(✓) Done: Container App: ca-api-vchqcvq7rwoju (17.742s)
63101

64-
Deploying services (azd deploy)
102+
Deploying services (azd deploy)
65103

66-
Deploying service api_and_frontend (Running remote build)
67-
- Endpoint: https://......eastus2.azurecontainerapps.io/
68-
────────────── Docker Output ─────────────────────────
104+
Deploying service api_and_frontend (Running remote build)
105+
- Endpoint: https://......eastus2.azurecontainerapps.io/
106+
────────────── Docker Output ─────────────────────────
69107

70-
──────────────────────────────────────────────────────
108+
──────────────────────────────────────────────────────
71109

72-
💡 (Optional) To setup username and password for the web application, run './scripts/setup_credential.sh'.
110+
💡 (Optional) To setup username and password for the web application, run './scripts/setup_credential.sh'.
73111

74-
SUCCESS: Your up workflow to provision and deploy to Azure completed in 11 minutes 50 seconds.
75-
```
112+
SUCCESS: Your up workflow to provision and deploy to Azure completed in 11 minutes 50 seconds.
113+
```
114+
!!! success "You should have a pre-provisioned Azure subscription - check the [Azure Portal](https://portal.azure.com)"

docs/Core-Labs/1-Get-Started/02.md

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,10 @@
11
# 1.2 Validate Infra
22

3-
## 1. Test Container App
3+
!!! quote "BY THE END OF THIS LAB YOU SHOULD HAVE"
44

5-
Click on the **Endpoint** URL provided in the output - or visit the Azure Portal and look for the Azure Container Apps resource and click the _Application Url_. You should see an agent application like this:
5+
- [X] Verified that your Azure AI Foundry project is setup
6+
- [X] Ensured that your Azure AI Search index is created
7+
- [X] Configured your local `.env` file to reflect deployments
68

7-
🌟 | Try asking a question like `Tell me about camping tents` - and see what happens.
9+
---
810

9-
![Deploy](./img/01-azd-deploy.png)
10-
11-
12-
## 2. Visit Agent Dashboard
13-
14-
Click the `Build & deploy agents with Azure AI Foundry` link (bottom left) to navigate to the underlying Agent on the Azure AI Foundry portal. You should see something like this:
15-
16-
🌟 | Select the agent name to see its details. Explore the integrated tools (Knowledge & Actions). Update the Agent description and instructions.
17-
- Agent name is helpful identification. _Change from "agent-template-assistant" to "cora-for-zava"_. Note how the changes are automatically saved. However, the container app will need to be updated separately.
18-
- Description is for human users. It does not affect agent behavior. Example: _Cora is a customer support agent for the Zava retail enterprise. Cora helps DIY enthusiasts find and purchase home improvement products in Zava stores._
19-
- Instructions are for agents. They guide agent actions. Example: _Use AI Search always. Avoid to use base knowledge._ - we'll modify this later.
20-
21-
![Deploy](./img/02-agent-dashboard.png)
22-
23-
Click **Try in playground** to activate the agent for interactive exploration.
24-
- See how changes made to description or instructions here are _automatically saved_ so they will be visible to agent detailed view in earlier dashboard.
25-
- Try asking [a sample question](https://github.com/Azure-Samples/get-started-with-ai-agents/blob/main/docs/sample_questions.md) like _What's the best tent under $200 for two people, and what features does it include?_ 🚨 - fix Azure AI Search. It is not grounded.
26-
27-
![Playground](./img/03-agent-playground.png)
28-
29-
Click the **View Run Info** button.
30-
- Note how this opens up a view into the traces for agent execution
31-
- Explore the waterfall diagram - see how each step provides token counts & time
32-
- Click on a _Run step_ and a _Tool_ item - how is the output different?
33-
- Click the _Evaluations_ tab - what does it tell us about quality & safety?
34-
35-
![Tracing](./img/04-agent-tracing.png)
36-
37-
- Close the tracing view - can you see the same token counts and latency metrics in the main view?
38-
- Hover over one of the numbers e.g., tokens - see the breakdown in token costs
39-
40-
![Metrics](./img/05-agent-metrics.png)
41-
42-
43-
![Deploy](./img/06-view-code.png)
44-
![Deploy](./img/07-open-vscode.png)
45-
![Deploy](./img/08-explore-project.png)
Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,54 @@
1-
# 2.1 Define Agent
1+
# 2.1 Define Agent
2+
3+
!!! quote "BY THE END OF THIS LAB YOU SHOULD HAVE"
4+
5+
- [X] Completed Task 1
6+
- [X] Completed Task 2
7+
- [X] Completed Task 3
8+
9+
---
10+
11+
12+
## 1. Test Container App
13+
14+
Click on the **Endpoint** URL provided in the output - or visit the Azure Portal and look for the Azure Container Apps resource and click the _Application Url_. You should see an agent application like this:
15+
16+
🌟 | Try asking a question like `Tell me about camping tents` - and see what happens.
17+
18+
![Deploy](./img/01-azd-deploy.png)
19+
20+
21+
## 2. Visit Agent Dashboard
22+
23+
Click the `Build & deploy agents with Azure AI Foundry` link (bottom left) to navigate to the underlying Agent on the Azure AI Foundry portal. You should see something like this:
24+
25+
🌟 | Select the agent name to see its details. Explore the integrated tools (Knowledge & Actions). Update the Agent description and instructions.
26+
- Agent name is helpful identification. _Change from "agent-template-assistant" to "cora-for-zava"_. Note how the changes are automatically saved. However, the container app will need to be updated separately.
27+
- Description is for human users. It does not affect agent behavior. Example: _Cora is a customer support agent for the Zava retail enterprise. Cora helps DIY enthusiasts find and purchase home improvement products in Zava stores._
28+
- Instructions are for agents. They guide agent actions. Example: _Use AI Search always. Avoid to use base knowledge._ - we'll modify this later.
29+
30+
![Deploy](./img/02-agent-dashboard.png)
31+
32+
Click **Try in playground** to activate the agent for interactive exploration.
33+
- See how changes made to description or instructions here are _automatically saved_ so they will be visible to agent detailed view in earlier dashboard.
34+
- Try asking [a sample question](https://github.com/Azure-Samples/get-started-with-ai-agents/blob/main/docs/sample_questions.md) like _What's the best tent under $200 for two people, and what features does it include?_ 🚨 - fix Azure AI Search. It is not grounded.
35+
36+
![Playground](./img/03-agent-playground.png)
37+
38+
Click the **View Run Info** button.
39+
- Note how this opens up a view into the traces for agent execution
40+
- Explore the waterfall diagram - see how each step provides token counts & time
41+
- Click on a _Run step_ and a _Tool_ item - how is the output different?
42+
- Click the _Evaluations_ tab - what does it tell us about quality & safety?
43+
44+
![Tracing](./img/04-agent-tracing.png)
45+
46+
- Close the tracing view - can you see the same token counts and latency metrics in the main view?
47+
- Hover over one of the numbers e.g., tokens - see the breakdown in token costs
48+
49+
![Metrics](./img/05-agent-metrics.png)
50+
51+
52+
![Deploy](./img/06-view-code.png)
53+
![Deploy](./img/07-open-vscode.png)
54+
![Deploy](./img/08-explore-project.png)
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
# 2.2 Run Agent
1+
# 2.2 Run Agent
2+
3+
!!! quote "BY THE END OF THIS LAB YOU SHOULD HAVE"
4+
5+
- [X] Completed Task 1
6+
- [X] Completed Task 2
7+
- [X] Completed Task 3
8+
9+
---
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
# 2.3 Analyze Run
1+
# 2.3 Analyze Run
2+
3+
!!! quote "BY THE END OF THIS LAB YOU SHOULD HAVE"
4+
5+
- [X] Completed Task 1
6+
- [X] Completed Task 2
7+
- [X] Completed Task 3
8+
9+
---
File renamed without changes.

docs/Core-Labs/1-Get-Started/img/02-agent-dashboard.png renamed to docs/Core-Labs/2-Explore-Agent/img/02-agent-dashboard.png

File renamed without changes.

0 commit comments

Comments
 (0)