Skip to content

Commit dff89e4

Browse files
committed
updating samples page
1 parent a4a885d commit dff89e4

File tree

7 files changed

+27
-4
lines changed

7 files changed

+27
-4
lines changed

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,25 @@ Use this article to learn how to use the Deep Research tool with the Azure AI Pr
2424
pip install --pre azure-ai-projects
2525
```
2626

27+
* Your Azure AI Foundry Project endpoint.
28+
29+
You can find your endpoint in the main project **overview** for your project in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs), under **Libraries** > **Azure AI Foundry**.
30+
31+
:::image type="content" source="../../media/quickstart/portal-endpoint-string.png" alt-text="A screenshot showing the endpoint in the Azure AI Foundry portal." lightbox="../../media/quickstart/portal-endpoint-string.png":::
32+
33+
Save this endpoint to an environment variable named `PROJECT_ENDPOINT`.
34+
35+
* The name of your Grounding with Bing Search resource name. You can find it in the Azure AI Foundry portal by selecting **Management center** from the left navigation menu. Then selecting **Connected resources**.
36+
37+
:::image type="content" source="../../media/tools/deep-research/bing-resource-name.png" alt-text="A screenshot showing the Grounding with Bing Search resource name. " lightbox="../../media/tools/deep-research/bing-resource-name.png":::
38+
39+
Save this endpoint to an environment variable named `BING_RESOURCE_NAME`.
40+
41+
* The names of your `o3-deep-research-model` deployment name and Azure OpenAI GPT model deployment name. You can find them in **Models + Endpoints** in the left navigation menu.
42+
43+
:::image type="content" source="../../media/tools/deep-research/model-deployments.png" alt-text="A screenshot showing the model deployment screen the AI Foundry portal." lightbox="../../media/tools/deep-research/model-deployments.png:::
44+
45+
Save the name of your `o3-deep-research-model` deployment name as an environment variable named `DEEP_RESEARCH_MODEL_DEPLOYMENT_NAME` and Azure OpenAI GPT model deployment name as an environment variable named `MODEL_DEPLOYMENT_NAME`.
2746

2847
> [!NOTE]
2948
> Limitation: The Deep Research tool is currently recommended only in nonstreaming scenarios. Using it with streaming can work, but it might occasionally time out and is therefore not recommended.
@@ -92,7 +111,8 @@ project_client = AIProjectClient(
92111
credential=DefaultAzureCredential(),
93112
)
94113

95-
conn_id = os.environ["AZURE_BING_CONNECTION_ID"]
114+
conn_id = project_client.connections.get(name=os.environ["BING_RESOURCE_NAME"]).id
115+
96116

97117
# Initialize a Deep Research tool with Bing Connection ID and Deep Research model deployment name
98118
deep_research_tool = DeepResearchTool(

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ The Deep Research tool in the Azure AI Foundry Agent Service enables you to inte
1717
> [!IMPORTANT]
1818
> * The Deep Research tool 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.
1919
> * The Agents service and SDK use the Azure OpenAI `o3-deep-research` model. This model is not accessible from Azure OpenAI Chat Completions and Responses APIs.
20+
> * When you use Grounding with Bing Search, your customer data is transferred outside of the Azure compliance boundary to the Grounding with Bing Search service. Grounding with Bing Search is not subject to the same data processing terms (including location of processing) and does not have the same compliance standards and certifications as the Azure AI Foundry Agent Service, as described in the [Grounding with Bing Search Terms of Use](https://www.microsoft.com/en-us/bing/apis/grounding-legal). It is your responsibility to assess whether use of Grounding with Bing Search in your agent meets your needs and requirements.
21+
22+
> [!NOTE]
2023
> * When using Grounding with Bing Search, only the Bing search query, tool parameters, and your resource key are sent to Bing, and no end user-specific information is included. Your resource key is sent to Bing solely for billing and rate limiting purposes.
2124
2225
## Usage support

articles/ai-foundry/agents/includes/endpoint-string-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ ms.date: 12/11/2024
88
---
99

1010
> [!TIP]
11-
> You can also find your endpoint in the **overview** for your project in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs), under **Libraries** > **Azure AI Foundry**.
11+
> You can find your endpoint in the **overview** for your project in the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs), under **Libraries** > **Azure AI Foundry**.
1212
> :::image type="content" source="../media/quickstart/portal-endpoint-string.png" alt-text="A screenshot showing the endpoint in the Azure AI Foundry portal." lightbox="../media/quickstart/portal-endpoint-string.png":::
135 KB
Loading
55.1 KB
Loading
77.6 KB
Loading

articles/ai-foundry/agents/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ items:
5454
- name: Overview
5555
href: how-to/tools/bing-custom-search.md
5656
displayName: bing, grounding with bing custom search
57-
- name: How to use Grounding with Bing Custom Search
58-
href: how-to/tools/bing-custom-search-samples.md
57+
- name: How to use Grounding with Bing Custom Search
58+
href: how-to/tools/bing-custom-search-samples.md
5959
- name: File search
6060
items:
6161
- name: Overview

0 commit comments

Comments
 (0)