Skip to content

Commit 490bd3a

Browse files
committed
Merge branch 'main' into release-aisvcs-move-rai-docs
2 parents 0c7c456 + 5d0434b commit 490bd3a

File tree

9 files changed

+419
-182
lines changed

9 files changed

+419
-182
lines changed

articles/ai-foundry/what-is-azure-ai-foundry.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: sdgilley
66
ms.author: sgilley
77
manager: scottpolly
88
ms.reviewer: sgilley
9-
ms.date: 05/12/2025
9+
ms.date: 06/12/2025
1010
ms.service: azure-ai-foundry
1111
ms.topic: overview
1212
ms.custom:
@@ -58,14 +58,16 @@ This table summarizes features available in the two project types:
5858
| Capability | [!INCLUDE [fdp](includes/fdp-project-name.md)] | [!INCLUDE[hub](includes/hub-project-name.md)] |
5959
| --- | --- | --- |
6060
| Agents | ✅ (GA) | ✅ (Preview only) |
61-
| Azure AI Foundry Models including Azure OpenAI models | ✅ (Native support) | Available via connections |
6261
| AI Foundry API to work with agents and across models| ✅ (Native support) | Available via connections |
63-
| Project files (directly upload files and start experimenting) || |
64-
| Project-level isolation of files and outputs |||
62+
| Models sold directly by Azure - Azure OpenAI, DeepSeek, xAI, etc. || Available via connections |
63+
| Partner & Community Models sold through Marketplace - Stability, Bria, Cohere, etc. || Available via connections |
64+
| Open source models e.g. HuggingFace | ||
6565
| Evaluations |||
6666
| Playground |||
6767
| Prompt flow | ||
68-
| Managed compute | ||
68+
| Content understanding | ||
69+
| Project files (directly upload files and start experimenting) || |
70+
| Project-level isolation of files and outputs |||
6971
| Required Azure dependencies | - | Azure Storage account, Azure Key Vault |
7072

7173
### <a name="how-do-i-know"></a> How do I know which type of project I have?

articles/ai-services/containers/includes/cognitive-services-container-security.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ The host should allowlist **port 443** and the following domains:
3636
* `*.cognitive.microsoft.com`
3737
* `*.cognitiveservices.azure.com`
3838

39+
If you are using the Azure AI Translator on-premise, you need to additionally allow the following URLs to download files
40+
41+
* `translatoronprem.blob.core.windows.net`
42+
3943
#### Disable deep packet inspection
4044

4145
[Deep packet inspection (DPI)](https://en.wikipedia.org/wiki/Deep_packet_inspection) is a type of data processing that inspects in detail the data sent over a computer network, and usually takes action by blocking, rerouting, or logging it accordingly.

articles/ai-services/includes/quickstarts/management-azportal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ keywords:
2424

2525
## Create a new Azure AI Foundry resource
2626

27-
AI Foundry portal provides a way to create a new Azure resource with basic, defaulted, settings. If your organization requires customized Azure configurations like alternative names, security controls or cost tags, you may have to use Azure portal or [template options](../../../ai-foundry/how-to/create-resource-template.md) to comply with your organization's Azure Policy compliance.
27+
[Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) provides a way to create a new Azure resource with basic, defaulted, settings. If your organization requires customized Azure configurations like alternative names, security controls or cost tags, you may need to instead use [Azure portal](https://portal.azure.com) or [template options](../../../ai-foundry/how-to/create-resource-template.md) to comply with your organization's Azure Policy compliance.
2828

2929
The Azure AI Foundry multi-service resource is listed under **AI Foundry** > **AI Foundry** in the portal. The API kind is **AIServices**. Look for the logo as shown here:
3030

articles/ai-services/openai/how-to/network-security-perimeter.md

Lines changed: 247 additions & 0 deletions
Large diffs are not rendered by default.

articles/ai-services/openai/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,8 @@ items:
269269
href: encrypt-data-at-rest.md
270270
- name: Managed identity
271271
href: ./how-to/managed-identity.md
272+
- name: Network security perimeter (preview)
273+
href: ./how-to/network-security-perimeter.md
272274
- name: Service management
273275
items:
274276
- name: Resource creation & model deployment

articles/search/includes/quickstarts/agentic-retrieval-python.md

Lines changed: 58 additions & 91 deletions
Large diffs are not rendered by default.

articles/search/includes/quickstarts/agentic-retrieval-rest.md

Lines changed: 17 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ author: haileytap
44
ms.author: haileytapia
55
ms.service: azure-ai-search
66
ms.topic: include
7-
ms.date: 05/30/2025
7+
ms.date: 6/15/2025
88
---
99

1010
[!INCLUDE [Feature preview](../previews/preview-generic.md)]
@@ -22,94 +22,26 @@ Although you can provide your own data, this quickstart uses [sample JSON docume
2222

2323
+ An [Azure AI Search service](../../search-create-service-portal.md) on the Basic tier or higher with [semantic ranker enabled](../../semantic-how-to-enable-disable.md).
2424

25-
+ An [Azure OpenAI resource](/azure/ai-services/openai/how-to/create-resource).
25+
+ An [Azure AI Foundry project](/azure/ai-foundry/how-to/create-projects). You get an Azure AI Foundry resource (that's needed for model deployments) when you create an Azure AI Foundry project.
2626

2727
+ [Visual Studio Code](https://code.visualstudio.com/download) with a [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).
2828

29-
## Deploy models
29+
+ The [Azure CLI](/cli/azure/install-azure-cli) for keyless authentication with Microsoft Entra ID.
3030

31-
To run agentic retrieval, you must deploy the following models to your Azure OpenAI resource:
32-
33-
+ An LLM for query planning.
34-
35-
+ An LLM for answer generation.
36-
37-
+ (Optional) An embedding model for vector queries.
38-
39-
Agentic retrieval [supports several models](../../search-agentic-retrieval-how-to-create.md#supported-models), but this quickstart assumes `gpt-4o-mini` for the query-planning LLM and `text-embedding-3-large` for the embedding model. To use the answer-generating LLM, see the Python version of this quickstart.
40-
41-
To deploy the Azure OpenAI models:
42-
43-
1. Sign in to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) and select your Azure OpenAI resource.
44-
45-
1. From the left pane, select **Model catalog**.
46-
47-
1. Select **gpt-4o-mini**, and then select **Use this model**.
48-
49-
1. Specify a deployment name. To simplify your code, we recommend **gpt-4o-mini**.
50-
51-
1. Accept the defaults.
52-
53-
1. Select **Deploy**.
54-
55-
1. Repeat the previous steps for **text-embedding-3-large**.
56-
57-
## Configure role-based access
58-
59-
Azure AI Search needs access to your Azure OpenAI models. For this task, you can use API keys or Microsoft Entra ID with role assignments. Keys are easier to start with, but roles are more secure. This quickstart assumes roles.
60-
61-
To configure the recommended role-based access:
62-
63-
1. Sign in to the [Azure portal](https://portal.azure.com/).
64-
65-
1. [Enable role-based access](../../search-security-enable-roles.md) on your Azure AI Search service.
66-
67-
1. [Create a system-assigned managed identity](../../search-howto-managed-identities-data-sources.md#create-a-system-managed-identity) on your Azure AI Search service.
68-
69-
1. On your Azure AI Search service, [assign the following roles](../../search-security-rbac.md#how-to-assign-roles-in-the-azure-portal) to yourself.
70-
71-
+ **Search Service Contributor**
72-
73-
+ **Search Index Data Contributor**
74-
75-
+ **Search Index Data Reader**
76-
77-
1. On your Azure OpenAI resource, assign **Cognitive Services User** to the managed identity of your search service.
78-
79-
## Get endpoints
80-
81-
In your code, you specify the following endpoints to establish connections with Azure AI Search and Azure OpenAI. These steps assume that you configured role-based access in the previous section.
82-
83-
To obtain your service endpoints:
84-
85-
1. Sign in to the [Azure portal](https://portal.azure.com/).
86-
87-
1. On your Azure AI Search service:
88-
89-
1. From the left pane, select **Overview**.
90-
91-
1. Copy the URL, which should be similar to `https://my-service.search.windows.net`.
92-
93-
1. On your Azure OpenAI resource:
94-
95-
1. From the left pane, select **Resource Management** > **Keys and Endpoint**.
96-
97-
1. Copy the URL, which should be similar to `https://my-resource.openai.azure.com`.
31+
[!INCLUDE [Setup](./agentic-retrieval-setup.md)]
9832

9933
## Connect from your local system
10034

10135
You configured role-based access to interact with Azure AI Search and Azure OpenAI. From the command line, use the Azure CLI to sign in to the same subscription and tenant for both services. For more information, see [Quickstart: Connect without keys](../../search-get-started-rbac.md).
10236

10337
To connect from your local system:
10438

105-
1. Run the following commands in sequence.
39+
1. Open a new terminal in Visual Studio Code and change to the directory where you want to save your files.
10640

107-
```azurecli
108-
az account show
41+
1. Run the following command and sign in with your Azure account. If you have multiple subscriptions, select the one that contains your Azure AI Search service and Azure AI Foundry project.
10942

110-
az account set --subscription <PUT YOUR SUBSCRIPTION ID HERE>
111-
112-
az login --tenant <PUT YOUR TENANT ID HERE>
43+
```azurecli
44+
az login
11345
```
11446
11547
1. To obtain your Microsoft Entra token, run the following command. You specify this value in the next section.
@@ -124,26 +56,27 @@ Before you send any requests, define credentials, endpoints, and deployment deta
12456

12557
To load the connections:
12658

127-
1. In Visual Studio Code, paste the following placeholders into a `.rest` or `.http` file.
59+
1. In Visual Studio Code create a `.rest` or `.http` file. For example, you can name the file `agentic-retrieval.rest`.
60+
1. Paste these placeholders into the new file:
12861

12962
```HTTP
13063
@baseUrl = PUT-YOUR-SEARCH-SERVICE-URL-HERE
13164
@token = PUT-YOUR-MICROSOFT-ENTRA-TOKEN-HERE
132-
@aoaiBaseUrl = PUT-YOUR-AOAI-URL-HERE
133-
@aoaiGptModel = gpt-4o-mini
134-
@aoaiGptDeployment = gpt-4o-mini
65+
@aoaiBaseUrl = PUT-YOUR-AI-FOUNDRY-URL-HERE
66+
@aoaiGptModel = gpt-4.1-mini
67+
@aoaiGptDeployment = gpt-4.1-mini
13568
@aoaiEmbeddingModel = text-embedding-3-large
13669
@aoaiEmbeddingDeployment = text-embedding-3-large
13770
@index-name = earth_at_night
13871
@agent-name = earth-search-agent
13972
@api-version = 2025-05-01-Preview
14073
```
14174
142-
1. Replace `@baseUrl` and `@aoaiBaseUrl` with the values you obtained in [Get endpoints](#get-endpoints).
75+
1. Set `@baseUrl` to your Azure AI Search endpoint, which looks like `https://<your-search-service-name>.search.windows.net.` Set `@aoaiBaseUrl` to your Azure AI Foundry endpoint, which looks like `https://<your-foundry-resource-name>.openai.azure.com.` You obtained both values in the [Get endpoints](#get-endpoints) section.
14376
14477
1. Replace `@token` with the Microsoft Entra token you obtained in [Connect from your local system](#connect-from-your-local-system).
14578
146-
1. To verify the variables, send the following request.
79+
1. In the same file, enter and send the following HTTP request to verify that you can connect to Azure AI Search. The request lists existing indexes in your search service.
14780
14881
```HTTP
14982
### List existing indexes by name
@@ -280,7 +213,7 @@ POST {{baseUrl}}/indexes/{{index-name}}/docs/index?api-version={{api-version}}
280213

281214
## Create a knowledge agent
282215

283-
To connect Azure AI Search to your `gpt-4o-mini` deployment and target the `earth_at_night` index at query time, you need a knowledge agent. Use [Create Knowledge Agents](/rest/api/searchservice/knowledge-agents/create?view=rest-searchservice-2025-05-01-preview&preserve-view=true) to define an agent named `earth-search-agent`, which you specified using the `@agent-name` variable in a previous section.
216+
To connect Azure AI Search to your `gpt-4.1-mini` deployment and target the `earth_at_night` index at query time, you need a knowledge agent. Use [Create Knowledge Agents](/rest/api/searchservice/knowledge-agents/create?view=rest-searchservice-2025-05-01-preview&preserve-view=true) to define an agent named `earth-search-agent`, which you specified using the `@agent-name` variable in a previous section.
284217

285218
To ensure relevant and semantically meaningful responses, `defaultRerankerThreshold` is set to exclude responses with a reranker score of `2.5` or lower.
286219

@@ -346,7 +279,7 @@ The output should be similar to the following JSON, where:
346279

347280
+ `response` provides a text string of the most relevant documents (or chunks) in the search index based on the user query. You can pass this string to an LLM for use as grounding data in answer generation.
348281

349-
+ `activity` tracks the steps that were taken during the retrieval process, including the subqueries generated by your `gpt-4o-mini` deployment and the tokens used for query planning and execution.
282+
+ `activity` tracks the steps that were taken during the retrieval process, including the subqueries generated by your `gpt-4.1-mini` deployment and the tokens used for query planning and execution.
350283

351284
+ `references` lists the documents that contributed to the response, each one identified by their `docKey`.
352285

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
manager: nitinme
3+
author: haileytap
4+
ms.author: haileytapia
5+
ms.service: azure-ai-search
6+
ms.topic: include
7+
ms.date: 6/15/2025
8+
---
9+
10+
## Configure role-based access
11+
12+
You can use search service API keys or Microsoft Entra ID with role assignments. Keys are easier to start with, but roles are more secure. This quickstart assumes roles.
13+
14+
To configure the recommended role-based access:
15+
16+
1. Sign in to the [Azure portal](https://portal.azure.com/).
17+
18+
1. [Enable role-based access](../../search-security-enable-roles.md) on your Azure AI Search service.
19+
20+
1. On your Azure AI Search service, [assign the following roles](../../search-security-rbac.md#how-to-assign-roles-in-the-azure-portal) to yourself.
21+
22+
+ **Search Service Contributor**
23+
24+
+ **Search Index Data Contributor**
25+
26+
+ **Search Index Data Reader**
27+
28+
For agentic retrieval, Azure AI Search also needs access to your Azure OpenAI Foundry resource.
29+
30+
1. [Create a system-assigned managed identity](../../search-howto-managed-identities-data-sources.md#create-a-system-managed-identity) on your Azure AI Search service. Here's how to do it using the Azure CLI:
31+
32+
```azurecli
33+
az search service update --name YOUR-SEARCH-SERVICE-NAME --resource-group YOUR-RESOURCE-GROUP-NAME --identity-type SystemAssigned
34+
```
35+
36+
If you already have a managed identity, you can skip this step.
37+
38+
1. On your Azure AI Foundry resource, assign **Cognitive Services User** to the managed identity that you created for your search service.
39+
40+
## Deploy models
41+
42+
To use agentic retrieval, you must deploy [one of the supported Azure OpenAI models](../../search-agentic-retrieval-how-to-create.md#supported-models) to your Azure AI Foundry resource:
43+
44+
+ A chat model for query planning and answer generation. We use `gpt-4.1-mini` in this quickstart. Optionally, you can use a different model for query planning and another for answer generation, but this quickstart uses the same model for simplicity.
45+
46+
+ An embedding model for vector queries. We use `text-embedding-3-large` in this quickstart, but you can use any embedding model that supports the `text-embedding` task.
47+
48+
To deploy the Azure OpenAI models:
49+
50+
1. Sign in to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) and select your Azure AI Foundry resource.
51+
52+
1. From the left pane, select **Model catalog**.
53+
54+
1. Select **gpt-4.1-mini**, and then select **Use this model**.
55+
56+
1. Specify a deployment name. To simplify your code, we recommend **gpt-4.1-mini**.
57+
58+
1. Leave the default settings.
59+
60+
1. Select **Deploy**.
61+
62+
1. Repeat the previous steps, but this time deploy the **text-embedding-3-large** embedding model.
63+
64+
## Get endpoints
65+
66+
In your code, you specify the following endpoints to establish connections with you Azure AI Search service and Azure AI Foundry resource. These steps assume that you [configured role-based access as described previously](#configure-role-based-access).
67+
68+
To obtain your service endpoints:
69+
70+
1. Sign in to the [Azure portal](https://portal.azure.com/).
71+
72+
1. On your Azure AI Search service:
73+
74+
1. From the left pane, select **Overview**.
75+
76+
1. Copy the URL, which should be similar to `https://my-service.search.windows.net`.
77+
78+
1. On your Azure AI Foundry resource:
79+
80+
1. From the left pane, select **Resource Management** > **Keys and Endpoint**.
81+
82+
1. Select the **OpenAI** tab and copy the URL that looks similar to `https://my-resource.openai.azure.com`.

articles/search/search-get-started-agentic-retrieval.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: haileytap
66
ms.author: haileytapia
77
ms.service: azure-ai-search
88
ms.topic: quickstart
9-
ms.date: 05/29/2025
9+
ms.date: 6/15/2025
1010
zone_pivot_groups: search-get-started-agentic-retrieval
1111
---
1212

0 commit comments

Comments
 (0)