Skip to content

Commit ffeca90

Browse files
authored
Merge pull request #4784 from aahill/release-build-agents
review updates
2 parents 356ef60 + 1ff18fa commit ffeca90

File tree

11 files changed

+132
-343
lines changed

11 files changed

+132
-343
lines changed

.openpublishing.redirection.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
},
9393
{
9494
"source_path_from_root": "/articles/ai-services/agents/how-to/tools/licensed-data.md",
95-
"redirect_url": "/azure/ai-services/agents/how-to/tools/catalog",
95+
"redirect_url": "/azure/ai-services/agents/how-to/tools/overview",
9696
"redirect_document_id": false
9797
},
9898
{

articles/ai-services/agents/how-to/tools/bing-code-samples.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ Follow the [REST API Quickstart](../../quickstart.md?pivots=rest-api) to set the
380380
To make the Grounding with Bing search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
381381
382382
```console
383-
curl $AZURE_AI_AGENTS_ENDPOINT/assistants?api-version=2024-12-01-preview \
383+
curl $AZURE_AI_AGENTS_ENDPOINT/assistants?api-version=2025-05-01 \
384384
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
385385
-H "Content-Type: application/json" \
386386
-d '{
@@ -391,9 +391,13 @@ curl $AZURE_AI_AGENTS_ENDPOINT/assistants?api-version=2024-12-01-preview \
391391
{
392392
"type": "bing_grounding",
393393
"bing_grounding": {
394-
"connections": [
394+
"search_configurations": [
395395
{
396-
"connection_id": "/subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>/providers/Microsoft.MachineLearningServices/workspaces/<your-project-name>/connections/<your-bing-connection-name>"
396+
"connection_id": "<your_connection_id>",
397+
"count": 7,
398+
"market": "en-US",
399+
"set_lang": "en",
400+
"freshness": "7d",
397401
}
398402
]
399403
}
@@ -405,7 +409,7 @@ curl $AZURE_AI_AGENTS_ENDPOINT/assistants?api-version=2024-12-01-preview \
405409
## Step 3: Create a thread
406410
407411
```console
408-
curl $AZURE_AI_AGENTS_ENDPOINT/threads?api-version=2024-12-01-preview \
412+
curl $AZURE_AI_AGENTS_ENDPOINT/threads?api-version=2025-05-01 \
409413
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
410414
-H "Content-Type: application/json" \
411415
-d ''
@@ -414,7 +418,7 @@ curl $AZURE_AI_AGENTS_ENDPOINT/threads?api-version=2024-12-01-preview \
414418
## Step 4: Add a user question to the thread
415419
416420
```console
417-
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2024-12-01-preview \
421+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
418422
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
419423
-H "Content-Type: application/json" \
420424
-d '{
@@ -428,7 +432,7 @@ curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2024-1
428432
Create a run and observe that the model uses the Grounding with Bing Search tool to provide a response to the user's question.
429433
430434
```console
431-
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs?api-version=2024-12-01-preview \
435+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs?api-version=2025-05-01 \
432436
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
433437
-H "Content-Type: application/json" \
434438
-d '{
@@ -439,19 +443,19 @@ curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs?api-version=2024-12-01
439443
### Retrieve the status of the run
440444
441445
```console
442-
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs/run_abc123?api-version=2024-12-01-preview \
446+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs/run_abc123?api-version=2025-05-01 \
443447
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
444448
```
445449
446450
### Retrieve the agent response
447451
448452
```console
449-
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2024-12-01-preview \
453+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
450454
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
451455
```
452456
453457
::: zone-end
454458
455459
## Next steps
456460
457-
[See the full sample for Grounding with Bing Search.](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-projects/samples/agents/sample_agents_bing_grounding.py)
461+
[See the full sample for Grounding with Bing Search.](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/ai/azure-ai-projects/samples/agents/sample_agents_bing_grounding.py)

articles/ai-services/agents/how-to/tools/bing-custom-search-samples.md

Lines changed: 102 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.custom: azure-ai-agents
1313
zone_pivot_groups: selection-bing-custom-grounding
1414
---
1515

16-
# How to use Grounding with Bing Custom Search
16+
# How to use Grounding with Bing Custom Search (preview)
1717

1818

1919
::: zone pivot="portal"
@@ -58,9 +58,9 @@ var projectClient = new AIProjectClient(connectionString, new DefaultAzureCreden
5858
AgentsClient agentClient = projectClient.GetAgentsClient();
5959
```
6060

61-
## Step 2: Create an Agent with the Grounding with Bing search tool enabled
61+
## Step 2: Create an Agent with the Grounding with Bing Custom Search tool enabled
6262

63-
To make the Grounding with Bing search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
63+
To make the Grounding with Bing Custom Search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
6464

6565
```csharp
6666
AgentsClient agentClient = projectClient.GetAgentsClient();
@@ -181,9 +181,9 @@ const client = AIProjectsClient.fromConnectionString(
181181
```
182182

183183

184-
## Step 2: Create an Agent with the Grounding with Bing search tool enabled
184+
## Step 2: Create an Agent with the Grounding with Bing Custom Search tool enabled
185185

186-
To make the Grounding with Bing search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
186+
To make the Grounding with Bing Custom Search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
187187

188188
```javascript
189189
const bingCustomSearchConnection = await client.connections.getConnection(
@@ -225,7 +225,7 @@ await client.agents.createMessage(
225225

226226
## Step 4: Create a run and check the output
227227

228-
Create a run and observe that the model uses the Grounding with Bing Search tool to provide a response to the user's question.
228+
Create a run and observe that the model uses the Grounding with Bing Custom Search tool to provide a response to the user's question.
229229

230230

231231
```javascript
@@ -302,9 +302,9 @@ project_client = AIProjectClient.from_connection_string(
302302
```
303303
304304
305-
## Step 2: Create an Agent with the Grounding with Bing search tool enabled
305+
## Step 2: Create an Agent with the Grounding with Bing Custom Search tool enabled
306306
307-
To make the Grounding with Bing search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
307+
To make the Grounding with Bing Custom Search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
308308
309309
```python
310310
bing_custom_connection = project_client.connections.get(connection_name=os.environ["BING_CUSTOM_CONNECTION_NAME"])
@@ -372,3 +372,97 @@ if response_message:
372372
373373
374374
:::zone-end
375+
376+
::: zone pivot="rest"
377+
378+
## Step 1: Create a project client
379+
380+
Create a client object, which will contain the connection string for connecting to your AI project and other resources.
381+
382+
>[!IMPORTANT]
383+
> 1. This REST API allows developers to invoke the Grounding with Bing Custom Search tool through the Azure AI Foundry Agent Service. It does not send calls to the Grounding with Bing Custom Search API directly.
384+
385+
Follow the [REST API Quickstart](../../quickstart.md?pivots=rest-api) to set the right values for the environment variables `AZURE_AI_AGENTS_TOKEN` and `AZURE_AI_AGENTS_ENDPOINT`. The client creation is demonstrated in the next section.
386+
387+
388+
## Step 2: Create an Agent with the Grounding with Bing Custom Search tool enabled
389+
390+
To make the Grounding with Bing Custom Search tool available to your agent, use a connection to initialize the tool and attach it to the agent. You can find your connection in the **connected resources** section of your project in the [Azure AI Foundry portal](https://ai.azure.com/).
391+
392+
```console
393+
curl $AZURE_AI_AGENTS_ENDPOINT/assistants?api-version=2025-05-15-preview \
394+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
395+
-H "Content-Type: application/json" \
396+
-d '{
397+
"instructions": "You are a helpful agent.",
398+
"name": "my-agent",
399+
"model": "gpt-4o",
400+
"tools": [
401+
{
402+
"type": "bing_custom_search",
403+
"bing_custom_search": {
404+
"search_configurations": [
405+
{
406+
"connection_id": <your_custom_search_connecion_id>,
407+
"instance_name": <your_custom_search_configuration_name>,
408+
"count": 7,
409+
"market": "en-US",
410+
"set_lang": "en",
411+
"freshness": "7d",
412+
}
413+
]
414+
}
415+
}
416+
]
417+
}'
418+
```
419+
420+
## Step 3: Create a thread
421+
422+
```console
423+
curl $AZURE_AI_AGENTS_ENDPOINT/threads?api-version=2025-05-15-preview \
424+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
425+
-H "Content-Type: application/json" \
426+
-d ''
427+
```
428+
429+
## Step 4: Add a user question to the thread
430+
431+
```console
432+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-15-preview \
433+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
434+
-H "Content-Type: application/json" \
435+
-d '{
436+
"role": "user",
437+
"content": "<ask a question tailored towards your web domains>"
438+
}'
439+
```
440+
441+
## Step 5: Create a run and check the output
442+
443+
Create a run and observe that the model uses the Grounding with Bing Custom Search tool to provide a response to the user's question.
444+
445+
```console
446+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs?api-version=2025-05-15-preview \
447+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
448+
-H "Content-Type: application/json" \
449+
-d '{
450+
"assistant_id": "asst_abc123",
451+
}'
452+
```
453+
454+
### Retrieve the status of the run
455+
456+
```console
457+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/runs/run_abc123?api-version=2025-05-15-preview \
458+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
459+
```
460+
461+
### Retrieve the agent response
462+
463+
```console
464+
curl $AZURE_AI_AGENTS_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-15-preview \
465+
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
466+
```
467+
468+
::: zone-end

articles/ai-services/agents/how-to/tools/bing-custom-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: aahi
1212
ms.custom: azure-ai-agents
1313
---
1414

15-
# Grounding with Bing Custom Search
15+
# Grounding with Bing Custom Search (preview)
1616

1717
Grounding with Bing Custom Search tool allows your Azure AI Agents to search within a configurable set of public web domains. It allows you to define the parts of the web you want to draw from so users only see relevant results from the domains and subdomains of your choosing. You need to first create a Grounding with Bing Custom Search resource in Azure portal.
1818

@@ -112,7 +112,7 @@ Grounding with Bing Custom Search is a powerful tool that allows you to select a
112112

113113
## Optional parameters
114114

115-
When you add the Grounding with Bing Custom Search tool to your agent, you can pass the following parameters. These parameters will impact the Grounding with Bing Custom Search tool output, and the AI model might not fully use all of the outputs. See the [code examples](./bing-code-samples.md) for information on API version support and how to pass these parameters.
115+
When you add the Grounding with Bing Custom Search tool to your agent, you can pass the following parameters. These parameters will impact the Grounding with Bing Custom Search tool output, and the AI model might not fully use all of the outputs. See the [code examples](./bing-custom-search-samples.md) for information on API version support and how to pass these parameters.
116116

117117
|Name|Value|Type|Required |
118118
|-|-|-|- |

articles/ai-services/agents/how-to/tools/fabric.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: aahi
1212
zone_pivot_groups: selection-fabric-data-agent
1313
---
1414

15-
# Use the Microsoft Fabric data agent
15+
# Use the Microsoft Fabric data agent (preview)
1616

1717
Integrate your Azure AI Agent with the [**Microsoft Fabric data agent**](https://go.microsoft.com/fwlink/?linkid=2312815) to unlock powerful data analysis capabilities. The Fabric data agent transforms enterprise data into conversational Q&A systems, allowing users to interact with the data through chat and uncover data-driven and actionable insights.
1818

0 commit comments

Comments
 (0)