Skip to content

Commit ac3ae65

Browse files
committed
updates
1 parent e21668f commit ac3ae65

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

articles/ai-foundry/agents/how-to/tools/deep-research-samples.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,15 @@ ms.author: aahi
1212
---
1313

1414
# How to use Deep Research
15-
Use this article to find step-by-step instructions and code samples for Grounding with Bing search.
15+
Use this article to find step-by-step instructions and code samples for the Deep Research tool.
1616

1717
## Prerequisites
1818

1919
* The requirements in the [Deep Research overview](./deep-research.md)
2020

21+
> [!NOTE]
22+
> Limitation: The Deep Research tool is currently recommended only in non-streaming scenarios. Using it with streaming can work, but it may occasionally time-out and is therefore not recommended.
23+
2124
## Create a project client
2225
Create a client object, which will contain the endpoint for connecting to your AI project and other resources.
2326

@@ -34,7 +37,7 @@ project_client = AIProjectClient(
3437

3538
```
3639
## Create an agent with the Grounding with Bing search tool enabled
37-
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. You also will need to specify the name of your Deep Research model.
40+
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. You also need to specify the name of your Deep Research model.
3841

3942
```python
4043
conn_id = os.environ["AZURE_BING_CONNECTION_ID"]
@@ -45,15 +48,20 @@ deep_research_tool = DeepResearchTool(
4548
deep_research_model=os.environ["DEEP_RESEARCH_MODEL_DEPLOYMENT_NAME"],
4649
)
4750

48-
with project_client.agents as agents_client:
51+
# Create Agent with the Deep Research tool and process Agent run
52+
with project_client:
53+
54+
with project_client.agents as agents_client:
4955

56+
# Create a new agent that has the Deep Research tool attached.
57+
# NOTE: To add Deep Research to an existing agent, fetch it with `get_agent(agent_id)` and then,
58+
# update the agent with the Deep Research tool.
5059
agent = agents_client.create_agent(
5160
model=os.environ["MODEL_DEPLOYMENT_NAME"],
5261
name="my-agent",
5362
instructions="You are a helpful Agent that assists in researching scientific topics.",
5463
tools=deep_research_tool.definitions,
5564
)
56-
print(f"Created agent, ID: {agent.id}")
5765
```
5866

5967
## Create a thread
@@ -85,7 +93,7 @@ print(f"Created message, ID: {message.id}")
8593
Create a run and observe the response to the question.
8694

8795
> [!NOTE]
88-
> According to Grounding with Bing's [terms of use and use and display requirements](https://www.microsoft.com/bing/apis/grounding-legal#use-and-display-requirements), you need to display both website URLs and Bing search query URLs in your custom interface. See the [Grounding with Bing Search documentation](./bing-grounding.md#how-to-display-grounding-with-bing-search-results) for more informaiton.
96+
> According to Grounding with Bing's [terms of use and use and display requirements](https://www.microsoft.com/bing/apis/grounding-legal#use-and-display-requirements), you need to display both website URLs and Bing search query URLs in your custom interface. See the [Grounding with Bing Search documentation](./bing-grounding.md#how-to-display-grounding-with-bing-search-results) for more information.
8997
9098
```python
9199
# Create and process Agent run in thread with tools

articles/ai-foundry/agents/how-to/tools/deep-research.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ ms.service: azure-ai-agent-service
1010
ms.topic: how-to
1111
---
1212

13-
# Deep Research tool
13+
# Deep Research tool (preview)
1414

15-
The Deep Research model in the Azure AI Foundry Agent Service enables you to use OpenAI's advanced agentic research capability, and integrate it with your data and systems.
15+
The Deep Research model in the Azure AI Foundry Agent Service enables you to use an advanced agentic research capability, and integrate it with your data and systems.
1616

1717
> [!IMPORTANT]
1818
> Deep Research uses **Grounding with Bing Search**. Be sure to read and understand all stipulations of its use, including potential [costs](https://www.microsoft.com/bing/apis/grounding-pricing) that can be incurred, the [terms of use](https://www.microsoft.com/bing/apis/grounding-legal), and [use and display requirements](./bing-grounding.md#how-to-display-grounding-with-bing-search-results). See the [Grounding with Bing Search](./bing-grounding.md) documentation for more information.

articles/ai-foundry/agents/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ items:
101101
displayName: azure functions, functions
102102
- name: How to use Azure Functions
103103
href: how-to/tools/azure-functions-samples.md
104-
- name: Deep Research
104+
- name: Deep Research (preview)
105105
items:
106106
- name: Overview
107107
href: how-to/tools/deep-research.md

0 commit comments

Comments
 (0)