Skip to content

Commit ba200c9

Browse files
committed
Merge branch 'rest-update' of https://github.com/aahill/azure-ai-docs-pr into rest-update
2 parents 72066b4 + 3eeebf2 commit ba200c9

File tree

4 files changed

+25
-26
lines changed

4 files changed

+25
-26
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Use this article to find step-by-step instructions and code samples for Groundin
2020
## Prerequisites
2121

2222
* A [connected Grounding with Bing Search resource](./bing-grounding.md#setup).
23+
* Your connection ID needs to be in this format: `/subscriptions/<subscription_id>/resourceGroups/<resource_group_name>/providers/Microsoft.CognitiveServices/accounts/<ai_service_name>/projects/<project_name>/connections/<connection_name>`
2324

2425
> [!IMPORTANT]
2526
> There are requirements for displaying Grounding with Bing Search results. See the [overview article](./bing-grounding.md#how-to-display-grounding-with-bing-search-results) for details.
@@ -483,7 +484,7 @@ curl --request GET \
483484
484485
### Retrieve the agent response
485486
486-
```console
487+
```bash
487488
curl --request GET \
488489
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-version=$API_VERSION \
489490
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
@@ -493,4 +494,4 @@ curl --request GET \
493494
494495
## Next steps
495496
496-
[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)
497+
[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.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The user query is the message that an end user sends to an agent, such as "what
3333
When a user sends a query, the customer's AI model deployment first processes it (using the provided instructions) to later perform a Bing Custom Search query (which is visible to developers). Grounding with Bing Custom Search returns relevant search results to the customer's model deployment, which then generates the final output.
3434

3535
> [!NOTE]
36-
> When using Grounding with Bing Custom Search, only the Bing Custom Search query, the configuration instance, 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.
36+
> When using Grounding with Bing Custom Search, the Bing Custom Search query, the configuration instance, 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.
3737
3838
The authorization will happen between Grounding with Bing Custom Search service and Azure AI Agent service. Any Bing Custom Search query that is generated and sent to Bing for the purposes of grounding is transferred, along with the resource key and configuration instance, outside of the Azure compliance boundary to the Grounding with Bing Custom Search service. Grounding with Bing Custom Search is subject to Bing's terms and don't have the same compliance standards and certifications as the Azure AI Agent Service, as described in the Grounding with Bing Custom Search Terms of Use. It's your responsibility to assess whether the use of Grounding with Bing Custom Search in your agent meets your needs and requirements.
3939

@@ -73,12 +73,10 @@ When you create or update a configuration, enter the following information:
7373
> * Domain and path (for example, `https://www.microsoft.com/surface`)
7474
> * Webpage (for example, `https://www.microsoft.com/en-us/p/surface-earbuds/8r9cpq146064`)
7575
76-
1. Allowed domains to search against.
76+
1. Allowed domains to search against. For allowed domains, if you want to include subpages, please make sure the domains have at most 2 levels of subpages.
7777

7878
1. Blocked domains to exclude from the search space.
7979

80-
1. Pinned domains to prioritize when searching on multiple domains, for specific search queries.
81-
8280

8381
1. Determine if you want to include subpages. A subpage slice specifies a domain path. Bing searches all content found at and below the path. You can specify a maximum of two subfolders in the path. For example, `www.microsoft.com/windows/`.
8482

@@ -105,8 +103,6 @@ Grounding with Bing Custom Search is a powerful tool that allows you to select a
105103

106104
1. If you own a public site that you want to include in the search but Bing hasn’t indexed, see the [Bing webmaster documentation](https://www.bing.com/webmaster/help/webmaster-guidelines-30fba23a) for details about getting your site indexed. The webmaster documentation also provides details about getting Bing to crawl your site if the index is out of date.
107105

108-
1. Any pinned domain is allowed by default and prioritized in the search slice.
109-
110106
1. You can only block certain domains and perform a search against the rest of the Web (a competitor’s site, for example).
111107

112108

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ When a user sends a query, the customer's AI model deployment first processes it
3333
Grounding with Bing returns relevant search results to the customer's model deployment, which then generates the final output.
3434

3535
> [!NOTE]
36-
> When using Grounding with Bing Search, only the Bing search query 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.
36+
> 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.
3737
3838
The authorization will happen between Grounding with Bing Search service and Azure AI Foundry Agent Service. Any Bing search query that is generated and sent to Bing for the purposes of grounding is transferred, along with the resource key, outside of the Azure compliance boundary to the Grounding with Bing Search service. Grounding with Bing Search is subject to Bing's terms and do 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/bing/apis/grounding-legal). It is your responsibility to assess whether the use of Grounding with Bing Search in your agent meets your needs and requirements.
3939

articles/ai-services/agents/includes/quickstart-rest.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,33 +33,30 @@ az login
3333

3434
Next, you will need to fetch the Entra ID token to provide as authorization to the API calls. Fetch the token using the CLI command:
3535
```azurecli
36-
az account get-access-token --resource 'https://ml.azure.com/' | jq -r .accessToken | tr -d '"'
36+
az account get-access-token --resource 'https://ai.azure.com' | jq -r .accessToken | tr -d '"'
3737
```
3838
Set the access token as an environment variable named `AZURE_AI_AGENTS_TOKEN`.
3939

40-
To successfully make REST API calls to Azure AI Agents Service, you will need to use the endpoint as below:
40+
To successfully make REST API calls to Azure AI Foundry Agent Service, you will need to use the endpoint as below:
4141

42-
`https://<HostName>/agents/v1.0/subscriptions/<AzureSubscriptionId>/resourceGroups/<ResourceGroup>/providers/Microsoft.MachineLearningServices/workspaces/<ProjectName>`
43-
44-
`HostName` can be found by navigating to your `discovery_url` and removing the leading `https://` and trailing `/discovery`. To find your `discovery_url`, run this CLI command:
45-
46-
```azurecli
47-
az ml workspace show -n {project_name} --subscription {subscription_name} --resource-group {resource_group_name} --query discovery_url
48-
```
42+
`https://<your_ai_service_name>.services.ai.azure.com/api/projects/<your_project_name>`
4943

5044
For example, your endpoint may look something like:
5145

52-
`https://eastus.api.azureml.ms/agents/v1.0/subscriptions/12345678-abcd-1234-abcd-123456789000/resourceGroups/my-resource-group/providers/Microsoft.MachineLearningServices/workspaces/my-project-name`
46+
`https://exampleaiservice.services.ai.azure.com/api/projects/project`
47+
48+
Set this endpoint as an environment variable named `AZURE_AI_FOUNDRY_PROJECT_ENDPOINT`.
5349

54-
Set this endpoint as an environment variable named `AZURE_AI_AGENTS_ENDPOINT`.
50+
For `API_VERSION`, the GA API version is `2025-05-01` and the latest Preview API version is `2025-05-15-preview`.
5551

5652
### Create an agent
5753

5854
> [!NOTE]
5955
> With Azure AI Agents Service the `model` parameter requires model deployment name. If your model deployment name is different than the underlying model name then you would adjust your code to ` "model": "{your-custom-model-deployment-name}"`.
6056
6157
```console
62-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/assistants?api-version=2025-05-01 \
58+
curl --request POST \
59+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/assistants?api-version=2025-05-01 \
6360
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
6461
-H "Content-Type: application/json" \
6562
-d '{
@@ -73,7 +70,8 @@ curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/assistants?api-version=2025-05-01 \
7370
### Create a thread
7471

7572
```console
76-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads?api-version=2025-05-01 \
73+
curl --request POST \
74+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads?api-version=2025-05-01 \
7775
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
7876
-H "Content-Type: application/json" \
7977
-d ''
@@ -82,7 +80,8 @@ curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads?api-version=2025-05-01 \
8280
### Add a user question to the thread
8381

8482
```console
85-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
83+
curl --request POST \
84+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
8685
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
8786
-H "Content-Type: application/json" \
8887
-d '{
@@ -94,7 +93,8 @@ curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-versi
9493
### Run the thread
9594

9695
```console
97-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/runs?api-version=2025-05-01 \
96+
curl --request POST \
97+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/runs?api-version=2025-05-01 \
9898
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN" \
9999
-H "Content-Type: application/json" \
100100
-d '{
@@ -105,13 +105,15 @@ curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/runs?api-version=2
105105
### Retrieve the status of the run
106106

107107
```console
108-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/runs/run_abc123?api-version=2025-05-01 \
108+
curl --request GET \
109+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/runs/run_abc123?api-version=2025-05-01 \
109110
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
110111
```
111112

112113
### Retrieve the agent response
113114

114115
```console
115-
curl $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
116+
curl --request GET \
117+
--url $AZURE_AI_FOUNDRY_PROJECT_ENDPOINT/threads/thread_abc123/messages?api-version=2025-05-01 \
116118
-H "Authorization: Bearer $AZURE_AI_AGENTS_TOKEN"
117119
```

0 commit comments

Comments
 (0)