Skip to content

Commit fe84690

Browse files
committed
Merge branch 'main' into release-aisvcs-move-rai-docs
2 parents 90f6487 + 831eae3 commit fe84690

File tree

9 files changed

+297
-599
lines changed

9 files changed

+297
-599
lines changed

articles/ai-foundry/agents/how-to/tools/openapi-spec-samples.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Find code samples to use OpenAPI tools with agents.
55
author: aahill
66
ms.author: aahi
77
manager: nitinme
8-
ms.date: 04/09/2025
8+
ms.date: 06/18/2025
99
ms.service: azure-ai-agent-service
1010
ms.topic: how-to
1111
ms.custom:
@@ -33,8 +33,8 @@ Use this article to find step-by-step instructions and code samples for using Op
3333

3434
:::image type="content" source="../../media\tools\open-api-details.png" alt-text="A screenshot showing the openAPI tool details in the Azure AI Foundry portal." lightbox="../../media\tools\open-api-details.png":::
3535

36-
1. Select **Next** and select your authentication method. Choose `connection` for `API key`.
37-
1. If you choose `connection`, you need to select the custom keys connection you have created before.
36+
1. Select **Next** and select your authentication method.
37+
1. If you choose `connection`, you need to select the custom connection you have created before.
3838
1. If you choose `managed identity`, you need to input the audience to get your token. An example of an audience would be `https://cognitiveservices.azure.com/` to connect to Azure AI Services. Make sure you have already set up authentication and role assignment (as described in the [section](./openapi-spec.md#authenticating-with-managed-identity-microsoft-entra-id) above).
3939

4040
1. Copy and paste your OpenAPI specification in the text box.
@@ -70,18 +70,14 @@ with AIProjectClient(
7070
) as project_client:
7171
```
7272

73-
## Countries Tool Setup
74-
Similarly, the OpenAPI specification for the countries service is loaded from `countries.json`. An anonymous authentication object (`OpenApiAnonymousAuthDetails`) is created, as this specific API doesn't require authentication in this example.
73+
## Tool setup
74+
Similarly, the OpenAPI specification is loaded from `weather.json`. An anonymous authentication object (`OpenApiAnonymousAuthDetails`) is created, as this specific API doesn't require authentication in this example. You can find an example OpenAPI spec on [GitHub](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/python/getting-started-agents/openapi/weather_openapi.json).
7575

7676
```python
77-
# Load the OpenAPI specification for the countries service from a local JSON file
77+
# Load the OpenAPI specification for the weather service from a local JSON file
7878
with open(os.path.join(os.path.dirname(__file__), "weather.json"), "r") as f:
7979
openapi_weather = jsonref.loads(f.read())
8080

81-
# Load the OpenAPI specification for the countries service from a local JSON file
82-
with open(os.path.join(os.path.dirname(__file__), "countries.json"), "r") as f:
83-
openapi_countries = jsonref.loads(f.read())
84-
8581
# Create Auth object for the OpenApiTool (note: using anonymous auth here; connection or managed identity requires additional setup)
8682
auth = OpenApiAnonymousAuthDetails()
8783
# for connection setup
@@ -93,10 +89,6 @@ Similarly, the OpenAPI specification for the countries service is loaded from `c
9389
openapi_tool = OpenApiTool(
9490
name="get_weather", spec=openapi_weather, description="Retrieve weather information for a location", auth=auth
9591
)
96-
# Add the countries API definition to the same tool object
97-
openapi_tool.add_definition(
98-
name="get_countries", spec=openapi_countries, description="Retrieve a list of countries", auth=auth
99-
)
10092
```
10193

10294
## Agent Creation
@@ -125,7 +117,7 @@ Create the thread and add the initial user message.
125117
message = project_client.agents.messages.create(
126118
thread_id=thread.id,
127119
role="user",
128-
content="What's the weather in Seattle and What is the name and population of the country that uses currency with abbreviation THB?",
120+
content="What's the weather in Seattle?",
129121
)
130122
print(f"Created message, ID: {message.id}")
131123
```
@@ -201,6 +193,8 @@ const client = new AgentsClient(projectEndpoint, new DefaultAzureCredential());
201193

202194
## Read in the OpenAPI spec
203195

196+
You can find an example OpenAPI spec on [GitHub](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/python/getting-started-agents/openapi/weather_openapi.json).
197+
204198
```javascript
205199
// Read in OpenApi spec
206200
const filePath = "./data/weatherOpenApi.json";
@@ -283,7 +277,7 @@ console.log(`Deleted agent, agent ID: ${agent.id}`);
283277
:::zone pivot="csharp"
284278

285279
## Configure client and OpenAPI tool
286-
First, retrieve configuration details and create a `PersistentAgentsClient`, then define the `OpenApiToolDefinition` using the OpenAPI specification.
280+
First, retrieve configuration details and create a `PersistentAgentsClient`, then define the `OpenApiToolDefinition` using the OpenAPI specification. You can find an example OpenAPI spec on [GitHub](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/python/getting-started-agents/openapi/weather_openapi.json).
287281

288282
```csharp
289283
using Azure;
@@ -392,7 +386,7 @@ Follow the [REST API Quickstart](../../quickstart.md?pivots=rest-api#api-call-in
392386

393387
## Create the OpenAPI Spec tool definition, agent, and thread
394388

395-
You might want to store the OpenAPI specification in another file and import the content to initialize the tool. This example is using `anonymous` as the authentication type.
389+
You might want to store the OpenAPI specification in another file and import the content to initialize the tool. This example is using `anonymous` as the authentication type. You can find an example OpenAPI spec on [GitHub](https://github.com/azure-ai-foundry/foundry-samples/blob/main/samples/microsoft/python/getting-started-agents/openapi/weather_openapi.json).
396390
397391
```bash
398392
curl --request POST \

articles/ai-foundry/how-to/develop/vscode.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Work with Azure AI Foundry projects in VS Code containers
2+
title: Use VS Code containers in hub based projects (Preview)
33
titleSuffix: Azure AI Foundry
44
description: This article provides instructions on how to get started with Azure AI Foundry projects in VS Code containers.
55
manager: scottpolly
@@ -9,18 +9,18 @@ ms.custom:
99
- build-2024
1010
- ignite-2024
1111
ms.topic: how-to
12-
ms.date: 02/14/2025
12+
ms.date: 06/18/2025
1313
ms.reviewer: lebaro
1414
ms.author: sgilley
1515
author: sdgilley
1616
# customer intent: As a Developer, I want to use Azure AI Foundry projects in VS Code containers.
1717
---
1818

19-
# Get started with Azure AI Foundry projects in VS Code containers (Preview)
19+
# Use VS Code containers in [!INCLUDE [hub-project-name](../../includes/hub-project-name.md)]s (Preview)
2020

2121
[!INCLUDE [feature-preview](../../includes/feature-preview.md)]
2222

23-
[Azure AI Foundry](https://ai.azure.com/?cid=learnDocs) supports developing in VS Code - Desktop and Web. In each scenario, your VS Code instance is remotely connected to a prebuilt custom container running on a virtual machine, also known as a compute instance.
23+
[Azure AI Foundry](https://ai.azure.com/?cid=learnDocs) supports developing in VS Code - Desktop and Web for [!INCLUDE [hub-project-name](../../includes/hub-project-name.md)]s. In each scenario, your VS Code instance is remotely connected to a prebuilt custom container running on a virtual machine, also known as a compute instance.
2424

2525
## Prerequisites
2626

@@ -35,15 +35,16 @@ author: sdgilley
3535
1. On the left menu, select **Templates**.
3636
1. Select **VS Code container**.
3737
1. For **Compute**, select an existing compute instance or create a new one.
38-
* Select a compute instance to use. If it's stopped, select **Start compute** and wait for it to switch to **Running**. You'll see a **Ready** status when the compute is ready for use.
39-
* If you don't have a compute instance, select **Create compute**. Then enter a name, compute details, and select **Create compute**. Wait until the compute instance is ready.
38+
* Select a compute instance to use. If it's stopped, select **Start compute** and wait for it to switch to **Running**. You see a **Ready** status when the compute is ready for use.
39+
* If you don't have a compute instance, select **Create compute**. Then enter a name, compute details, and select **Create compute**. Wait until the compute instance is ready.
4040
1. If prompted, select **Authenticate** to authenticate your compute instance.
41-
1. For **VS Code container**, select **Set up container** once the button enables. This configures the container on the compute for you. The container setup might take a few minutes to complete. Once you set up the container for the first time, you can directly launch subsequent times. When setup is complete, you'll see **Ready**.
41+
1. For **VS Code container**, select **Set up container** once the button enables. This setting configures the container on the compute for you. The container setup might take a few minutes to complete. Once you set up the container for the first time, you can directly launch subsequent times. When setup is complete, you see **Ready**.
4242

4343
> [!WARNING]
44-
> Even if you [enable idle shutdown on your compute instance](../create-manage-compute.md#configure-idle-shutdown), idle shutdown will not occur for any compute that is set up with this custom VS Code container. This is to ensure the compute doesn't shut down unexpectedly while you're working within a container.
44+
> Even if you [enable idle shutdown on your compute instance](../create-manage-compute.md#configure-idle-shutdown), idle shutdown won't occur for any compute that is set up with this custom VS Code container. This is to ensure the compute doesn't shut down unexpectedly while you're working within a container.
4545
4646
1. Once your container is ready, launch VS Code:
47+
4748
* If you want to work in your local VS Code instance, choose **Launch in VS Code (Desktop)**. A new local instance of VS Code opens on your local machine.
4849
* If you want to work in the browser instead, select the dropdown arrow and choose **Launch in VS Code (Web)**. A new browser tab connected to *vscode.dev* opens.
4950

@@ -108,4 +109,3 @@ For app templates and SDK samples in your preferred programming language, see [D
108109
## Related content
109110

110111
- [Get started building a chat app using the prompt flow SDK](../../quickstarts/get-started-code.md)
111-
- [Get started with Azure AI Foundry SDKs](sdk-overview.md)

articles/ai-foundry/tutorials/deploy-chat-web-app.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom:
99
- build-2024
1010
- ignite-2024
1111
ms.topic: tutorial
12-
ms.date: 02/13/2025
12+
ms.date: 06/18/2025
1313
ms.reviewer: tgokal
1414
ms.author: sgilley
1515
author: sdgilley
@@ -73,7 +73,7 @@ To start, identify the resources you need to configure from the Azure AI Foundry
7373
7474
1. For each resource, select the link to open the resource details. From the details page, select the resource name to open the resource in the Azure portal. (For the workspaceblobstore, select **View in Azure Portal**).
7575
1. After the browser tab opens, go back to the Azure AI Foundry portal and repeat the process for the next resource.
76-
1. When you're done, you should have three new browser tabs open, for **Search service**, **Azure AI services**, and **blobstore Container**. Keep all three new tabs open as you'll go back and forth between them to configure the resources.
76+
1. When you're done, you should have three new browser tabs open, for **Search service**, **Azure AI Foundry**, and **blobstore Container**. Keep all three new tabs open as you'll go back and forth between them to configure the resources.
7777

7878
### Enable managed identity
7979

@@ -83,7 +83,7 @@ On the browser tab for the **Search service** resource in the Azure portal, enab
8383
1. Switch **Status** to **On**.
8484
1. Select **Save**.
8585

86-
On the browser tab for the **Azure AI services** resource in the Azure portal, enable the managed identity:
86+
On the browser tab for the **Azure AI Foundry** resource in the Azure portal, enable the managed identity:
8787

8888
1. From the left pane, under **Resource Management**, select **Identity**.
8989
1. Switch **Status** to **On**.
@@ -106,18 +106,18 @@ You'll repeat this pattern multiple times in the bulleted items below.
106106
Use these steps to assign roles for the resources you're configuring in this tutorial:
107107

108108
* Assign the following roles on the browser tab for **Search service** in the Azure portal:
109-
* **Search Index Data Reader** to the **Azure AI services** managed identity
110-
* **Search Service Contributor** to the **Azure AI services** managed identity
109+
* **Search Index Data Reader** to the **Azure AI Foundry** managed identity
110+
* **Search Service Contributor** to the **Azure AI Foundry** managed identity
111111
* **Contributor** to yourself (to find **Contributor**, switch to the **Privileged administrator roles** tab at the top. All other roles are in the **Job function roles** tab.)
112112

113-
* Assign the following roles on the browser tab for **Azure AI services** in the Azure portal:
113+
* Assign the following roles on the browser tab for **Azure AI Foundry** in the Azure portal:
114114

115115
* **Cognitive Services OpenAI Contributor** to the **Search service** managed identity
116116
* **Contributor** to yourself.
117117

118118
* Assign the following roles on the browser tab for **Azure Blob storage** in the Azure portal:
119119

120-
* **Storage Blob Data Contributor** to the **Azure AI services** managed identity
120+
* **Storage Blob Data Contributor** to the **Azure AI Foundry** managed identity
121121
* **Storage Blob Data Reader** to the **Search service** managed identity
122122
* **Contributor** to yourself
123123

articles/ai-services/cognitive-services-data-loss-prevention.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ There are two parts to enable data loss prevention. First, the resource property
2626
>[!NOTE]
2727
>
2828
> * The `allowedFqdnList` property value supports a maximum of 1000 URLs.
29-
> * The property supports fully qualified domain names (i.e., `www.microsoft.com`) as values.
29+
> * The property supports fully qualified domain names (i.e., `www.contoso.com`) as values.
3030
> * It can take up to 15 minutes for the updated list to take effect.
3131
3232
# [Azure CLI](#tab/azure-cli)
@@ -52,7 +52,7 @@ There are two parts to enable data loss prevention. First, the resource property
5252
```azurecli-interactive
5353
az rest -m patch \
5454
-u /subscriptions/{subscription ID}/resourceGroups/{resource group}/providers/Microsoft.CognitiveServices/accounts/{account name}?api-version=2024-10-01 \
55-
-b '{"properties": { "restrictOutboundNetworkAccess": true, "allowedFqdnList": [ "microsoft.com" ] }}'
55+
-b '{"properties": { "restrictOutboundNetworkAccess": true, "allowedFqdnList": [ "contoso.com" ] }}'
5656
```
5757
5858
# [PowerShell](#tab/powershell)
@@ -82,7 +82,7 @@ There are two parts to enable data loss prevention. First, the resource property
8282
ResourceType = 'accounts'
8383
Name = 'myaccount'
8484
ApiVersion = '2024-10-01'
85-
Payload = '{"properties": { "restrictOutboundNetworkAccess": true, "allowedFqdnList": [ "microsoft.com" ] }}'
85+
Payload = '{"properties": { "restrictOutboundNetworkAccess": true, "allowedFqdnList": [ "contoso.com" ] }}'
8686
Method = 'PATCH'
8787
}
8888
Invoke-AzRestMethod @patchParams

articles/ai-services/openai/concepts/content-streaming.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ To enable Asynchronous Filter in [Azure AI Foundry portal](https://ai.azure.com/
3737
| Compare | Streaming - Default | Streaming - Asynchronous Filter |
3838
|---|---|---|
3939
|Status |GA |Public Preview |
40-
| Eligibility |All customers |Customers approved for modified content filtering |
41-
| How to enable | Enabled by default, no action needed |Customers approved for modified content filtering can configure it directly in [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) (as part of a content filtering configuration, applied at the deployment level) |
40+
| Eligibility |All customers |All customers |
41+
| How to enable | Enabled by default, no action needed |Customers can configure it directly in [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) (as part of a content filtering configuration, applied at the deployment level) |
4242
|Modality and availability |Text; all GPT models |Text; all GPT models |
4343
|Streaming experience |Content is buffered and returned in chunks |Zero latency (no buffering, filters run asynchronously) |
4444
|Content filtering signal |Immediate filtering signal |Delayed filtering signal (in up to ~1,000-character increments) |

0 commit comments

Comments
 (0)