You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-foundry/how-to/develop/get-started-projects-vs-code.md
+34-15Lines changed: 34 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ content_well_notification:
8
8
- AI-contribution
9
9
ai-usage: ai-assisted
10
10
ms.topic: how-to
11
-
ms.date: 07/10/2025
11
+
ms.date: 08/05/2025
12
12
ms.reviewer: erichen
13
13
ms.author: johalexander
14
14
author: ms-johnalex
@@ -48,7 +48,20 @@ Before using the Azure AI Foundry for Visual Studio Code extension, you must:
48
48
49
49
After you install Visual Studio Code, you need to install the Azure AI Foundry for Visual Studio Code extension.
50
50
51
-
To install the Azure AI Foundry for Visual Studio Code extension:
51
+
To install the Azure AI Foundry for Visual Studio Code extension, you can either use the Visual Studio Code Marketplace or install it directly from within Visual Studio Code.
52
+
53
+
### Install from the Visual Studio Code Marketplace
54
+
To install the Azure AI Foundry for Visual Studio Code extension from the Visual Studio Code Marketplace, follow these steps:
55
+
56
+
1. Open the [Azure AI Foundry for Visual Studio Code extension page](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.vscode-ai-foundry).
57
+
1. Select the **Install** button.
58
+
1. Follow the prompts to install the extension in Visual Studio Code.
59
+
1. After installation, open Visual Studio Code and verify the extension is installed successfully from the status messages.
60
+
1. The extension should now be visible in the primary navigation bar on the left side of Visual Studio Code.
61
+
62
+
### Install from within Visual Studio Code
63
+
64
+
To install the Azure AI Foundry for Visual Studio Code extension in Visual Studio Code, follow these steps:
52
65
53
66
1. Open Visual Studio Code.
54
67
@@ -70,7 +83,6 @@ Get started with the Azure AI Foundry extension by using the following steps.
70
83
> For a full list of features available in the extension, use the Command Palette. Select <kbd>F1</kbd> to open the command palette and search **Azure AI Foundry**. The following screenshot shows some of the actions for Azure AI Foundry.
71
84
> :::image type="content" source="../../media/how-to/get-started-projects-vs-code/visual-studio-command-palette-small.png" alt-text="A screenshot of the Visual Studio Code command palette for Azure AI Foundry." lightbox="../../media/how-to/get-started-projects-vs-code/visual-studio-command-palette-small.png":::
72
85
73
-
74
86
### Sign in to your resources
75
87
76
88
Sign in to your Azure subscription to access your resources with the following steps:
@@ -101,6 +113,9 @@ The Azure AI Foundry Extension opens in its own view, with the Azure AI Foundry
101
113
-**Resources**: This section contains the resources you have access to in your Azure AI Foundry project. The **Resources** section is the main view for interacting with your Azure AI Foundry Services. It contains the following subsections:
102
114
-**Models**: This section contains the models you can use to build and deploy your AI applications. The **Models** view is where you can find your deployed models in your Azure AI Foundry project.
103
115
-**Agents**: This section contains your deployed agents in your Azure AI Foundry project.
116
+
-**Assets**: This section contains the assets you have in your Azure AI Foundry project.
117
+
- Connections: This subsection contains the connections you have in your Azure AI Foundry project. for example, Bing Grounding connections.
118
+
- Vector Stores: This subsection contains the vector stores you have in your Azure AI Foundry project.
104
119
-**Threads**: This section contains the threads and runs from a deployed agent in your Azure AI Foundry project.
105
120
106
121
-**Tools**: This section contains the tools you can use to build and deploy your AI applications. The **Tools** view is where you can find the tools available to deploy and then work with your deployed models and agents. It contains the following subsections:
@@ -112,6 +127,7 @@ The Azure AI Foundry Extension opens in its own view, with the Azure AI Foundry
112
127
-**Documentation**: The link to the Azure AI Foundry Extension documentation.
113
128
-**GitHub**: The link to the Azure AI Foundry extension GitHub repository.
114
129
-**Microsoft Privacy Statement**: The link to the Microsoft Privacy Statement.
130
+
-**Join the Foundry Community: Discord + Forum**: The link to the Azure AI Foundry community Discord server.
115
131
116
132
>[!NOTE]
117
133
> To learn more about working with Agents and Threads in the Azure AI Foundry Extension, see the [Work with Azure AI Foundry Agent Service in Visual Studio Code](./vs-code-agents.md) article.
@@ -130,11 +146,11 @@ You can either create a new resource group or select an existing one.
130
146
- To create a new resource group:
131
147
1. In the top center, select **Create new resource group** and press Enter.
132
148
133
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-resource-group.png" alt-text="Screenshot of the Choose resource group dropdown with the Create new resource group item highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/select-resource-group.png":::
149
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-resource-group.png" alt-text="Screenshot of the Choose resource group dropdown with the Create new resource group item highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/select-resource-group.png":::
134
150
135
-
1. In the top center, enter the Azure Resource Group name to use in the **Enter new resource group** textbox and press Enter.
151
+
2. In the top center, enter the Azure Resource Group name to use in the **Enter new resource group** textbox and press Enter.
136
152
137
-
1. In the top center, select the location you want to use from the list of available locations and press Enter.
153
+
3. In the top center, select the location you want to use from the list of available locations and press Enter.
138
154
139
155
- To use an existing resource group:
140
156
1. In the top center, select the resource group you want to use from the list of available resource groups and press Enter.
@@ -213,21 +229,24 @@ Deploy a selected model in the model catalog using the following steps:
213
229
214
230
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/deploy-from-model-catalog.png" alt-text="Screenshot of the highlighted Deploy in Azure link of the selected model." lightbox="../../media/how-to/get-started-projects-vs-code/deploy-from-model-catalog.png":::
215
231
216
-
1. In the top center, select the AI service to use in the **Choose an AI service** dropdown and press Enter.
232
+
1. The **Model deployment** page is displayed.
233
+
234
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/model-deployment-page.png" alt-text="Screenshot of the **Model deployment** page in VS Code." lightbox="../../media/how-to/get-started-projects-vs-code/model-deployment-page.png":::
217
235
218
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/choose-ai-service.png" alt-text="Screenshot of the Choose an AI service dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/choose-ai-service.png":::
236
+
1. Enter the model deployment name to use in the **Enter deployment name** textbox and press Enter.
219
237
220
-
1. In the top center, select the model version to use in the **Choose model version** dropdown and press Enter.
238
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/enter-deployment-name.png" alt-text="Screenshot of the Enter deployment name textbox." lightbox="../../media/how-to/get-started-projects-vs-code/enter-deployment-name.png":::
239
+
1. Select the deployment type to use in the **Deployment type** dropdown and press Enter.
221
240
222
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-model-version.png" alt-text="Screenshot of the Choose model version dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/select-model-version.png":::
241
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png" alt-text="Screenshot of the Deployment type dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png":::
223
242
224
-
1.In the top center, select the deployment type to use in the **Choose deployment type** dropdown and press Enter.
243
+
1.Select the model version to use in the **Model version** dropdown and press Enter.
225
244
226
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png" alt-text="Screenshot of the Choose deployment type dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/select-deployment-type.png":::
245
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/select-model-version.png" alt-text="Screenshot of the Model version dropdown." lightbox="../../media/how-to/get-started-projects-vs-code/select-model-version.png":::
227
246
228
-
1.In the top center, enter the model deployment name to use in the **Enter deployment name**textbox and press Enter.
247
+
1.(Optional) Select the tokens per minute to use in the **Tokens per minute**slider and press Enter.
229
248
230
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/enter-deployment-name.png" alt-text="Screenshot of the Enter deployment name textbox." lightbox="../../media/how-to/get-started-projects-vs-code/enter-deployment-name.png":::
249
+
1. In the bottom-left corner, select the **Deploy in Azure AI Foundry** button to deploy the model.
231
250
232
251
1. A confirmation dialog box appears. Select the **Deploy** button to deploy the model to your project.
233
252
@@ -345,4 +364,4 @@ Delete the connected tool with the following steps:
345
364
346
365
## Next steps
347
366
348
-
- Learn about [working with the Azure AI Foundry Agent Service](./vs-code-agents.md) using this Visual Studio Code extension.
367
+
- Learn about [working with the Azure AI Foundry Agent Service](./vs-code-agents.md) using this Visual Studio Code extension.
### Create and edit Azure AI Agents within the designer view
31
+
## Create and edit Azure AI Agents within the designer view
32
32
33
33
Follow these steps to create an Azure AI Agent:
34
34
@@ -62,7 +62,7 @@ After you choose your save location, both the agent .yaml file and the Designer
62
62
63
63
1. To save the .yaml file, select **File** > **Save** in the VS Code menu bar.
64
64
65
-
### Explore the Azure AI Agent YAML definition
65
+
### Explore the Azure AI Agent YAML definition
66
66
67
67
Your AI Agent .yaml file was opened at the same time the designer was. This file contains the details and setup information for your agent, similar to the following .yaml file example:
68
68
@@ -88,80 +88,49 @@ instructions: Instructions for the agent
88
88
tools: []
89
89
```
90
90
91
-
### Add tools to the Azure AI Agent
91
+
## Add tools to the Azure AI Agent
92
92
93
+
Azure AI Agent Service has a set of tools that you can use to interact with your data sources.
93
94
94
-
Azure AI Agent Service has a set of knowledge and action tools that you can use to interact with your data sources.
95
+
#### Available tools for Azure AI Agents in the Azure AI Foundry VS Code extension
95
96
97
+
The following tools are available in the Azure AI Foundry VS Code extension:
96
98
97
-
#### Available tools for Azure AI Agents
98
-
99
-
The following tools are available:
100
-
101
-
- Knowledge tools:
102
99
- [Grounding with Bing search](/azure/ai-services/agents/how-to/tools/bing-grounding?tabs=python&pivots=overview)
1. Choose a tool from the [available tools for Azure AI Agents](#available-tools-for-azure-ai-agents). Perform any setup steps that might be required. For example, [Grounding with Bing search](/azure/ai-services/agents/how-to/tools/bing-grounding?tabs=python&pivots=overview#setup).
126
104
127
-
1. Once you complete the setup, create a yaml code file that specifies the tool's configuration. For example, this format for Grounding with Bing Search:
128
-
129
-
```yml
130
-
type: bing_grounding
131
-
options:
132
-
tool_connections:
133
-
- >-
134
-
/subscriptions/<Azure Subscription ID>/resourceGroups/<Azure Resource Group name>/providers/Microsoft.MachineLearningServices/workspaces/<Azure AI Foundry Project name>/connections/<Bing connection name>
135
-
```
136
-
1. Replace the placeholders in the connection string under the `tool_connections` section with your information:
137
-
138
-
- Azure Subscription ID
139
-
- Azure Resource Group name
140
-
- Azure AI Foundry Project name
141
-
- Bing connection name
142
-
143
-
1. To save the .yaml file, select **File** > **Save** in the VS Code menu bar.
144
-
145
-
#### Connect the tools file to the AI Agent
105
+
#### Add a tool to the AI Agent
146
106
147
107
Add a tool to the AI Agent with the following steps:
148
108
149
109
1. Select the **Add tool** button in the top-right corner of the **TOOL** section in the designer to show the dropdown. Choose the tool you want to add.
150
110
151
111
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-tool-plus.png" alt-text="Screenshot of the Agent designer TOOL section with the plus icon highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/agent-tool-plus.png":::
152
112
153
-
1. In the file explorer that appears, select the .yaml tool file to use. Select the **Select a tool file** button to add the tool to the agent.
154
113
155
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-select-tool-file.png" alt-text="Screenshot of the file explorer with the selected file and the 'Select a tool file' button highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/agent-select-tool-file.png":::
114
+
1. The designer displays the appropriate pane to configure the tool, as in the following images:
156
115
157
-
1. The tool is displayed in the **TOOL** section.
116
+
Code interpreter tool dialog box:
117
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-ci-tool-dialog.png" alt-text="Screenshot of the Code interpreter tool dialog box." lightbox="../../media/how-to/get-started-projects-vs-code/agent-ci-tool-dialog.png":::
118
+
119
+
File upload tool dialog box:
120
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-file-search-tool-dialog.png" alt-text="Screenshot of the File upload tool dialog box." lightbox="../../media/how-to/get-started-projects-vs-code/agent-file-search-tool-dialog.png":::
158
121
159
-
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-added-tool.png" alt-text="Screenshot of the Agent designer TOOL section with the new tool highlighted." lightbox="../../media/how-to/get-started-projects-vs-code/agent-added-tool.png":::
122
+
Grounding with Bing Search dialog box:
123
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-bing-tool-dialog.png" alt-text="Screenshot of the Grounding with Bing Search tool dialog box." lightbox="../../media/how-to/get-started-projects-vs-code/agent-bing-tool-dialog.png":::
160
124
161
-
1. To save the tool .yaml file, select **File** > **Save** in the VS Code menu bar.
125
+
OpenAPI 3.0 Specified dialog box:
126
+
:::image type="content" source="../../media/how-to/get-started-projects-vs-code/agent-openapi-tool-dialog.png" alt-text="Screenshot of the OpenAPI 3.0 Specified tool dialog box." lightbox="../../media/how-to/get-started-projects-vs-code/agent-openapi-tool-dialog.png":::
162
127
128
+
1. After entering the required information, select the **Upload and save** button in the bottom-left corner.
129
+
130
+
> [!NOTE]
131
+
> When you add a tool, you can also add any new assets it needs. For example, if you add a File Search tool, you can use an existing vector store asset or make a new asset for your vector store to host your uploaded files.
163
132
164
-
### Create Azure AI Agents on the Azure AI Foundry Studio
133
+
### Create Azure AI Agents on the Azure AI Foundry Studio
165
134
166
135
Create your agent directly on Azure AI Foundry with the following steps:
0 commit comments