Skip to content

Commit f05970c

Browse files
ferantiverockittel
andauthored
patch (orchestrator): [docs] add point and click instructions to create a new agent (#48)
Co-authored-by: Chad Kittel <chad.kittel@gmail.com>
1 parent 918eace commit f05970c

File tree

2 files changed

+30
-77
lines changed

2 files changed

+30
-77
lines changed

README.md

Lines changed: 30 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -107,78 +107,59 @@ The following steps are required to deploy the infrastructure from the command l
107107

108108
### 2. Deploy an agent in the Azure AI Agent service
109109

110-
To test this scenario, you'll be deploying an AI agent included in this repository. The agent uses a GPT model combined with a Bing search for grounding data. Deploying an AI agent requires data plane access to Azure AI Foundry. In this architecture, you will interact with the Azure AI Foundry portal and its resources over internet.
110+
To test this scenario, you'll be deploying an AI agent. The agent uses a GPT model combined with a Bing search for grounding data. Deploying an AI agent requires data plane access to Azure AI Foundry. In this architecture, you will interact with the Azure AI Foundry portal and its resources over internet.
111111

112-
The AI agent definition would likely be deployed from your application's pipeline running from a build agent or it could be deployed via singleton code in your web application. In this deployment, you'll create the agent from the terminal, which most closely simulates pipeline-based creation.
113-
114-
1. Generate some variables to set context.
115-
116-
*The following variables align with the defaults in this deployment. Update them if you customized anything.*
117-
118-
```bash
119-
AI_FOUNDRY_NAME="aif${BASE_NAME}"
120-
BING_CONNECTION_NAME="bingaiagent"
121-
AI_FOUNDRY_PROJECT_NAME="projchat"
122-
BING_CONNECTION_ID="$(az cognitiveservices account show -n $AI_FOUNDRY_NAME -g $RESOURCE_GROUP --query 'id' --out tsv)/projects/${AI_FOUNDRY_PROJECT_NAME}/connections/${BING_CONNECTION_NAME}"
123-
MODEL_CONNECTION_NAME="agent-model"
124-
AI_FOUNDRY_AGENT_CREATE_URL="https://${AI_FOUNDRY_NAME}.services.ai.azure.com/api/projects/${AI_FOUNDRY_PROJECT_NAME}/assistants?api-version=2025-05-15-preview"
125-
126-
echo $BING_CONNECTION_ID
127-
echo $MODEL_CONNECTION_NAME
128-
echo $AI_FOUNDRY_AGENT_CREATE_URL
129-
```
112+
1. Open the Azure portal to your subscription.
130113

131-
1. Deploy the agent.
114+
1. Navigate to the Azure AI Foundry project named **projchat** in your resource group and open the Azure AI Foundry portal by clicking the Go to **Azure AI Foundry portal** button.
132115

133-
*This step simulates deploying an AI agent through your pipeline.*
116+
This will take you directly into the 'Chat project'. Alternatively, you can find all your AI Foundry accounts and projects by going to <https://ai.azure.com> and you do not need to use the Azure portal to access them.
134117

135-
```bash
136-
# Use the agent definition on disk
137-
wget "https://github.com/Azure-Samples/openai-end-to-end-basic/raw/refs/heads/main/agents/chat-with-bing.json"
118+
1. Click **Agents** in the side navigation.
138119

139-
# Update to match your environment
140-
cat chat-with-bing.json | \
141-
sed "s#MODEL_CONNECTION_NAME#${MODEL_CONNECTION_NAME}#g" | \
142-
sed "s#BING_CONNECTION_ID#${BING_CONNECTION_ID}#g" \
143-
> chat-with-bing-output.json
120+
1. Click **+ New agent** button.
144121

145-
# Deploy the agent
146-
az rest -u $AI_FOUNDRY_AGENT_CREATE_URL -m "post" --resource "https://ai.azure.com" -b @chat-with-bing-output.json
147-
```
122+
1. From the Setup panel, change the Agent name to 'Baseline Chatbot Agent'.
148123

149-
1. Get Agent Id value
124+
1. Click **+ Add** button in the Knowledge section.
150125

151-
```bash
152-
AGENT_ID=$(az rest -u $AI_FOUNDRY_AGENT_CREATE_URL -m "get" --resource "https://ai.azure.com" --query 'data[0].id' -o tsv)
126+
1. From the popup window select the knowledge type 'Grounding with Bing Search'.
153127

154-
echo $AGENT_ID
155-
````
128+
1. Then choose the existing connection named 'bingaiagent' and click the **Connect** button.
156129

157-
### 3. Test the agent from the Azure AI Foundry portal in the playground. *Optional.*
130+
### 3. Test the agent from the Azure AI Foundry portal in the playground.
158131

159132
Here you'll test your orchestration agent by invoking it directly from the Azure AI Foundry portal's playground experience.
160133

161-
*This step testing step is completely optional.*
134+
1. Click the **Try in playground** button.
162135

163-
1. Open the Azure portal to your subscription.
136+
1. Enter a question that would require grounding data through recent internet content, such as a notable recent event or the weather today in your location.
164137

165-
1. Navigate to the Azure AI Foundry project named **projchat** in your resource group and open the Azure AI Foundry portal by clicking the **Go to Azure AI Foundry portal** button.
138+
1. A grounded response to your question should appear on the UI.
166139

167-
This will take you directly into the 'Chat project'. Alternatively, you can find all your AI Foundry accounts and projects by going to <https://ai.azure.com> and you do not need to use the Azure portal to access them.
140+
### 4. Publish the chat front-end web app
168141

169-
1. Click **Agents** in the side navigation.
142+
Workloads build chat functionality into an application. Those interfaces usually call Azure AI Foundry project endpoint invoking a particular agent. This implementation comes with such an interface. You'll deploy it to Azure App Service using the Azure CLI.
170143

171-
1. Select the agent named 'Baseline Chatbot Agent'.
144+
1. Generate some variables to set context.
172145

173-
1. Click the **Try in playground** button.
146+
*The following variables align with the defaults in this deployment. Update them if you customized anything.*
174147

175-
1. Enter a question that would require grounding data through recent internet content, such as a notable recent event or the weather today in your location.
148+
```bash
149+
AI_FOUNDRY_NAME="aif${BASE_NAME}"
150+
AI_FOUNDRY_PROJECT_NAME="projchat"
151+
AI_FOUNDRY_AGENT_CREATE_URL="https://${AI_FOUNDRY_NAME}.services.ai.azure.com/api/projects/${AI_FOUNDRY_PROJECT_NAME}/assistants?api-version=2025-05-15-preview"
176152

177-
1. A grounded response to your question should appear on the UI.
153+
echo $AI_FOUNDRY_AGENT_CREATE_URL
154+
```
178155

179-
### 4. Publish the chat front-end web app
156+
1. Get Agent ID value.
180157

181-
Workloads build chat functionality into an application. Those interfaces usually call Azure AI Foundry project endpoint invoking a particular agent. This implementation comes with such an interface. You'll deploy it to Azure App Service using the Azure CLI.
158+
```bash
159+
AGENT_ID=$(az rest -u $AI_FOUNDRY_AGENT_CREATE_URL -m "get" --resource "https://ai.azure.com" --query 'data[0].id' -o tsv)
160+
161+
echo $AGENT_ID
162+
````
182163

183164
1. Update the app configuration to use the agent you deployed.
184165

agents/chat-with-bing.json

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)