Skip to content

Commit 06dd573

Browse files
authored
Merge pull request #2481 from aahill/foundry-docs
foundry quickstart
2 parents 73e1ba1 + 6d1f490 commit 06dd573

File tree

9 files changed

+83
-55
lines changed

9 files changed

+83
-55
lines changed
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
manager: nitinme
3+
author: aahill
4+
ms.author: aahi
5+
ms.service: azure
6+
ms.topic: include
7+
ms.date: 01/21/2025
8+
---
9+
10+
## Prerequisites
11+
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>.
12+
- An [Azure AI hub resource](../../../ai-studio/how-to/create-azure-ai-resource.md) with a model deployed. For more information about model deployment, see the [resource deployment guide](../../../ai-studio/how-to/create-azure-ai-resource.md).
13+
- An [Azure AI project](../../../ai-studio/how-to/create-projects.md) in Azure AI Foundry portal.
14+
- Make sure you have the **Azure AI Developer** [RBAC role](../../../ai-studio/concepts/rbac-ai-studio.md) assigned.
15+
16+
## Go to the Azure AI Foundry portal (Preview)
17+
18+
1. Sign in to [Azure AI Foundry](https://ai.azure.com).
19+
1. Go to your project or [create a new project](../../../ai-studio//how-to/create-projects.md) in Azure AI Foundry portal.
20+
1. From your project overview, select **Agents**, located under **playgrounds**. The Agents playground allows you to explore, prototype, and test AI Agents without needing to run any code. From this page, you can quickly iterate and experiment with new ideas.
21+
22+
1. Select your Azure OpenAI resource and optionally an Azure AI Search resource.
23+
24+
> [!IMPORTANT]
25+
> * If you don't select an Azure AI Search resource, A Microsoft-managed storage will be used to contain your data. If you do select an Azure AI Search resource, then customer-managed storage will be used.
26+
> * If you don't select an Azure AI Search resource now, and begin using customer-managed storage later, the data stored in the Microsoft-managed storage will be lost.
27+
28+
:::image type="content" source="../media/quickstart/agents-foundry.png" alt-text="A screenshot of the initial Agents screen." lightbox="../media/quickstart/agents-foundry.png":::
29+
30+
1. Select a [model](../concepts/model-region-support.md) deployment for the Agent to use. If you don't have one, a screen to deploy a new model will open. Otherwise you can select **Deploy a model**.
31+
32+
:::image type="content" source="../media/quickstart/select-deploy-model.png" alt-text="A screenshot of the model selection screen." lightbox="../media/quickstart/select-deploy-model.png":::
33+
34+
:::image type="content" source="../media/quickstart/model-list.png" alt-text="A screenshot of the available models." lightbox="../media/quickstart/model-list.png":::
35+
36+
1. In the **Create and debug your agents** screen that appears, select **New agent**. This will create a new agent, and open a **Setup** pane where you can change its parameters and tools.
37+
38+
You can optionally give your agent a name other than the one generated for it, and add instructions to help improve its performance. Give your agent clear directions on what to do and how to do it. Include specific tasks, their order, and any special instructions like tone or engagement style.
39+
40+
:::image type="content" source="../media/quickstart/create-debug-agent.png" alt-text="A screenshot of the Agents create and debug screen." lightbox="../media/quickstart/create-debug-agent.png":::
41+
42+
> [!TIP]
43+
> Your agent can access multiple [**tools**](../how-to/tools/overview.md) that extend its capabilities, such as the ability to search the web with Bing, run code, and more. In the **Setup** pane, scroll down to **knowledge** and **action** and select **Add** to see the tools available for use.
44+
> :::image type="content" source="../media/quickstart/portal-tools.png" alt-text="A screenshot of the Agents tool choices." lightbox="../media/quickstart/portal-tools.png":::
45+
46+
47+
48+
1. At the top of the **Setup** pane, select **Try in playground** to start using your agent.
49+
50+
## Use your agent
51+
52+
The **Agents playground** allows you to explore, prototype, and test agents without needing to run any code. From this page, you can quickly iterate and experiment with new ideas. When you interact with an agent, it:
53+
54+
1. Creates a thread object, which contains the context for a conversation, including individual messages sent between the agent and a user.
55+
56+
1. Appends a message object to the thread. A new message will be added to the thread for each turn of a conversation between an agent and a user.
57+
58+
1. Creates a run object on the thread to generate a response by calling the model and any tools you've added.
59+
60+
To interact with your agent:
61+
62+
1. Optionally change the **agent name** if you want, and add **instructions**. Instructions guide the personality of the agent and define its goals. Instructions are similar to [system messages](../../openai/concepts/advanced-prompt-engineering.md).
63+
64+
1. In the chat area of the playground, enter a message and wait for the agent to respond.
65+
66+
:::image type="content" source="../media/quickstart/agents-playground.png" alt-text="A screenshot of the Agents playground." lightbox="../media/quickstart/agents-playground.png":::
67+
68+
## See also
69+
70+
* See the [tools overview](../how-to/tools/overview.md) to learn about the tools you can allow your agent to use to extend its capabilities.
749 KB
Loading
160 KB
Loading
232 KB
Loading
470 KB
Loading
325 KB
Loading
719 KB
Loading

articles/ai-services/agents/quickstart.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,20 @@ ms.author: aahi
88
ms.service: azure-ai-agent-service
99
ms.topic: quickstart
1010
ms.date: 12/11/2024
11-
zone_pivot_groups: programming-languages-agents
11+
zone_pivot_groups: agents-quickstart
1212
ms.custom: azure-ai-agents
1313
---
1414

1515
# Quickstart: Create a new agent
1616

1717
Azure AI Agent Service allows you to create AI agents tailored to your needs through custom instructions and augmented by advanced tools like code interpreter, and custom functions.
1818

19+
::: zone pivot="ai-foundry"
20+
21+
[!INCLUDE [quickstart-ai-foundry](includes/quickstart-foundry.md)]
22+
23+
::: zone-end
24+
1925
::: zone pivot="programming-language-csharp"
2026

2127
[!INCLUDE [quickstart-csharp](includes/quickstart-csharp.md)]

zone-pivots/zone-pivot-groups.yml

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,6 @@ groups:
3838
title: C#
3939
- id: programming-language-rest
4040
title: REST
41-
- id: azure-ai-model-catalog-sub-group-samples
42-
# Owner: mopeakande
43-
title: Programming languages
44-
prompt: Choose a tool or API
45-
pivots:
46-
- id: programming-language-python
47-
title: Python
48-
- id: programming-language-rest
49-
title: REST
5041
- id: programming-languages-set-conmod
5142
# Owner: pafarley
5243
title: Programming languages
@@ -146,7 +137,7 @@ groups:
146137
prompt: Choose your preferred usage method
147138
pivots:
148139
- id: programming-language-studio
149-
title: Portal
140+
title: Studio
150141
- id: programming-language-csharp
151142
title: C#
152143
- id: programming-language-go
@@ -575,21 +566,6 @@ groups:
575566
title: "JavaScript: Node.js"
576567
- id: programming-language-python
577568
title: Python
578-
- id: azure-ai-inference-samples
579-
# Owner: santiagxf
580-
title: Programing languages
581-
prompt: Choose a tool or API
582-
pivots:
583-
- id: programming-language-python
584-
title: Python
585-
- id: programming-language-javascript
586-
title: JavaScript
587-
- id: programming-language-java
588-
title: Java
589-
- id: programming-language-csharp
590-
title: C#
591-
- id: programming-language-rest
592-
title: REST
593569
- id: azure-ai-model-catalog-samples-embeddings
594570
# Owner: santiagxf
595571
title: Programing languages
@@ -601,17 +577,6 @@ groups:
601577
title: JavaScript
602578
- id: programming-language-rest
603579
title: REST
604-
- id: azure-ai-models-deployment
605-
# Owner: santiagxf
606-
title: Prograaming languages
607-
prompt: Choose a tool or API
608-
pivots:
609-
- id: ai-foundry-portal
610-
title: Foundry portal
611-
- id: programming-language-cli
612-
title: Azure CLI
613-
- id: programming-language-bicep
614-
title: Bicep
615580
- id: aml-control-methods
616581
# Owner: gopalv
617582
title: Azure Machine Learning control plane
@@ -951,10 +916,12 @@ groups:
951916
title: Python
952917
- id: programming-language-typescript
953918
title: TypeScript
954-
- id: programming-languages-agents
955-
title: Programming languages
956-
prompt: Choose a programming language
919+
- id: agents-quickstart
920+
title: Usage methods
921+
prompt: Choose a usage method
957922
pivots:
923+
- id: ai-foundry
924+
title: AI Foundry
958925
- id: programming-language-csharp
959926
title: C#
960927
- id: programming-language-python-azure
@@ -1022,18 +989,3 @@ groups:
1022989
title: Python
1023990
- id: programming-language-csharp
1024991
title: C#
1025-
- id: audio-completions-quickstart
1026-
# Owner: eur
1027-
title: Programming languages
1028-
prompt: Choose a tool or API
1029-
pivots:
1030-
- id: ai-foundry-portal
1031-
title: Portal
1032-
- id: programming-language-javascript
1033-
title: JavaScript
1034-
- id: programming-language-python
1035-
title: Python
1036-
- id: programming-language-typescript
1037-
title: TypeScript
1038-
- id: rest-api
1039-
title: REST

0 commit comments

Comments
 (0)