You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-foundry/model-inference/how-to/quickstart-github-models.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ To obtain the key and endpoint:
47
47
48
48
5. If your existing account is a free account, you first have to upgrade to a Pay as you go plan. Once you upgrade, go back to the playground and select **Get API key** again, then sign in with your upgraded account.
49
49
50
-
6. Once you've signed in to your Azure account, you're taken to [Azure AI Studio > GitHub](https://ai-azure.com/GitHub). It might take one or two minutes to load your initial model details in AI Studio.
50
+
6. Once you've signed in to your Azure account, you're taken to [Azure AI Studio > GitHub](https://ai.azure.com/GitHub). It might take one or two minutes to load your initial model details in AI Studio.
51
51
52
52
7. The page is loaded with your model's details. Select the **Deploy** button to deploy the model to your account.
Copy file name to clipboardExpand all lines: articles/ai-services/agents/how-to/tools/bing-grounding.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,6 +44,8 @@ Developers and end users don't have access to raw content returned from Groundin
44
44
1. Create a Grounding with Bing Search resource. You need to have `owner` or `contributor` role in your subscription or resource group to create it.
45
45
46
46
1. You can create one in the [Azure portal](https://portal.azure.com/#create/Microsoft.BingGroundingSearch), and select the different fields in the creation form. Make sure you create this Grounding with Bing Search resource in the same resource group as your Azure AI Agent, AI Project, and other resources.
47
+
48
+
:::image type="content" source="../../media/tools/bing/resource-selection.png" alt-text="A screenshot of the Bing resource selection in the Azure portal." lightbox="../../media/tools/bing/resource-selection.png":::
47
49
48
50
1. You can also create one through code-first experience. If so, you need to manually [register](/azure/azure-resource-manager/management/resource-providers-and-types#register-resource-provider) Bing Search as an Azure resource provider. You must have permission to perform the `/register/action` operation for the resource provider. The permission is included in the **Contributor** and **Owner** roles.
Copy file name to clipboardExpand all lines: articles/ai-services/authentication.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,22 @@
2
2
title: Authentication in Azure AI services
3
3
titleSuffix: Azure AI services
4
4
description: "There are three ways to authenticate a request to an Azure AI services resource: a resource key, a bearer token, or a multi-service subscription. In this article, you'll learn about each method, and how to make a request."
5
-
author: mgreenegit
5
+
author: eric-urban
6
6
manager: nitinme
7
7
ms.service: azure-ai-services
8
8
ms.custom: devx-track-azurepowershell
9
9
ms.topic: how-to
10
-
ms.date: 8/1/2024
11
-
ms.author: migreene
10
+
ms.date: 2/7/2025
11
+
ms.author: eur
12
12
---
13
13
14
14
# Authenticate requests to Azure AI services
15
15
16
16
Each request to an Azure AI service must include an authentication header. This header passes along a resource key or authentication token, which is used to validate your subscription for a service or group of services. In this article, you'll learn about three ways to authenticate a request and the requirements for each.
17
17
18
-
* Authenticate with a [single-service](#authenticate-with-a-single-service-resource-key) or [multi-service](#authenticate-with-a-multi-service-resource-key) resource key
19
-
* Authenticate with a [token](#authenticate-with-an-access-token)
20
-
* Authenticate with [Microsoft Entra ID](#authenticate-with-azure-active-directory)
18
+
* Authenticate with a [single-service](#authenticate-with-a-single-service-resource-key) or [multi-service](#authenticate-with-a-multi-service-resource-key) resource key.
19
+
* Authenticate with a [token](#authenticate-with-an-access-token).
20
+
* Authenticate with [Microsoft Entra ID](#authenticate-with-azure-active-directory).
21
21
22
22
## Prerequisites
23
23
@@ -106,7 +106,7 @@ Some Azure AI services accept, and in some cases require, an access token. Curre
106
106
* Speech Services: Speech to text API
107
107
* Speech Services: Text to speech API
108
108
109
-
>[!WARNING]
109
+
>[!WARNING]
110
110
> The services that support access tokens may change over time, please check the API reference for a service before using this authentication method.
111
111
112
112
Both single service and multi-service resource keys can be exchanged for authentication tokens. Authentication tokens are valid for 10 minutes. They're stored in JSON Web Token (JWT) format and can be queried programmatically using the [JWT libraries](https://jwt.io/libraries).
@@ -176,13 +176,13 @@ The first step is to create a custom subdomain. If you want to use an existing A
2. Next, [create an Azure AI services resource](/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccount) with a custom subdomain. The subdomain name needs to be globally unique and cannot include special characters, such as: ".", "!", ",".
179
+
1. Next, [create an Azure AI services resource](/powershell/module/az.cognitiveservices/new-azcognitiveservicesaccount) with a custom subdomain. The subdomain name needs to be globally unique and cannot include special characters, such as: ".", "!", ",".
@@ -211,7 +211,7 @@ Now that you have a custom subdomain associated with your resource, you're going
211
211
> [!NOTE]
212
212
> If you register an application in the Azure portal, this step is completed for you.
213
213
214
-
3. The last step is to [assign the "Cognitive Services User" role](/powershell/module/az.Resources/New-azRoleAssignment) to the service principal (scoped to the resource). By assigning a role, you're granting service principal access to this resource. You can grant the same service principal access to multiple resources in your subscription.
214
+
1. The last step is to [assign the "Cognitive Services User" role](/powershell/module/az.Resources/New-azRoleAssignment) to the service principal (scoped to the resource). By assigning a role, you're granting service principal access to this resource. You can grant the same service principal access to multiple resources in your subscription.
215
215
216
216
> [!NOTE]
217
217
> The ObjectId of the service principal is used, not the ObjectId for the application.
@@ -231,7 +231,7 @@ In this sample, a password is used to authenticate the service principal. The to
231
231
$context.Tenant.Id
232
232
```
233
233
234
-
2. Get a token:
234
+
1. Get a token:
235
235
```powershell-interactive
236
236
$tenantId = $context.Tenant.Id
237
237
$clientId = $app.ApplicationId
@@ -253,7 +253,7 @@ In this sample, a password is used to authenticate the service principal. The to
253
253
> [!NOTE]
254
254
> Anytime you use passwords in a script, the most secure option is to use the PowerShell Secrets Management module and integrate with a solution such as Azure Key Vault.
@@ -284,7 +284,7 @@ You can [use Azure Key Vault](./use-key-vault.md) to securely develop Azure AI s
284
284
285
285
Authentication is done via Microsoft Entra ID. Authorization may be done via Azure role-based access control (Azure RBAC) or Key Vault access policy. Azure RBAC can be used for both management of the vaults and access data stored in a vault, while key vault access policy can only be used when attempting to access data stored in a vault.
286
286
287
-
## See also
287
+
## Related content
288
288
289
289
*[What are Azure AI services?](./what-are-ai-services.md)
290
290
*[Azure AI services pricing](https://azure.microsoft.com/pricing/details/cognitive-services/)
Copy file name to clipboardExpand all lines: articles/ai-services/create-account-resource-manager-template.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: eric-urban
6
6
manager: nitinme
7
7
ms.service: azure-ai-services
8
8
ms.topic: quickstart
9
-
ms.date: 8/1/2024
9
+
ms.date: 2/7/2025
10
10
ms.author: eur
11
11
ms.custom:
12
12
- subject-armqs
@@ -35,7 +35,7 @@ The template that you use in this quickstart is from [Azure Quickstart Templates
35
35
36
36
One Azure resource is defined in the Bicep file. The `kind` field in the Bicep file defines the type of resource.
37
37
38
-
As needed, change the `sku` parameter value to the [pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) instance you want. The `sku` depends on the resource `kind` that you use. For example, use `TextAnalytics` for the Azure AI Language service. The `TextAnalytics` kind uses `S` instead of `S0` for the `sku` value.
38
+
As needed, change the `sku` parameter value to the [pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) instance you want. The `sku` depends on the resource `kind` that you use. For example, use `AIServices` for the Azure AI Language service.
- An Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services/).
24
24
- The cURL command line tool installed. Windows 10 and Windows 11 ship with a copy of cURL. At a command prompt, type the following cURL command. If the help options display, cURL is installed in your Windows environment.
25
25
26
-
```console
26
+
```bash
27
27
curl -help
28
28
```
29
29
@@ -60,18 +60,18 @@ Use the following table as a reference. Replace *\<modelId>* and *\<document-url
60
60
61
61
## POST request
62
62
63
-
Open a console window and run the following cURL command. The commands include the endpoint and key environment variables previously created in the set environment variables section. Replace those variables if your variable names differ. Remember to replace the *\<modelId>* and *\<document-url>* parameters.
63
+
Open a bash window and run the following cURL command. The commands include the endpoint and key environment variables previously created in the set environment variables section. Replace those variables if your variable names differ. Remember to replace the *\<modelId>* and *\<document-url>* parameters.
To enable add-on capabilities, use the `features` query parameter in the POST request. There are four add-on capabilities available with the `2023-07-31` (GA) and later releases: *ocr.highResolution*, *ocr.formula*, *ocr.font*, and *queryFields.premium*. To learn more about each of the capabilities, see [Custom models](../../../concept/accuracy-confidence.md).
70
70
71
71
You can only call the *highResolution*, *formula*, and *font* capabilities for the Read and Layout model, and the *queryFields* capability for the General Documents model. The following example shows how to call the *highResolution*, *formula*, and *font* capabilities for the Layout model.
@@ -82,7 +82,7 @@ You receive a `202 (Success)` response that includes an `Operation-location` hea
82
82
83
83
### Get analyze result (GET Request)
84
84
85
-
After you call the [`Analyze document`](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) API, call the [`Get analyze` result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) API to get the status of the operation and the extracted data.
85
+
After you call the [`Analyze document`](/rest/api/aiservices/document-models/analyze-batch-documents?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true&tabs=HTTP) API, call the [`Get analyze` result](/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true&tabs=HTTP) API to get the status of the operation and the extracted data.
86
86
87
87
<!-- markdownlint-disable MD024 -->
88
88
@@ -92,16 +92,16 @@ The cURL command line tool doesn't format API responses that contain JSON conten
92
92
93
93
Use the NodeJS *json tool* as a JSON formatter for cURL. If you don't have [Node.js](https://nodejs.org/) installed, download and install the latest version.
94
94
95
-
1. Open a console window and install the json tool by using the following command:
95
+
1. Open a bash window and install the json tool by using the following command:
96
96
97
-
```console
97
+
```bash
98
98
npm install -g jsontool
99
99
```
100
100
101
101
1. Pretty print the JSON output by including the pipe character `| json` with your GET requests.
102
102
103
-
```console
104
-
curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json
103
+
```bash
104
+
curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>"| json
105
105
```
106
106
107
107
#### [macOS](#tab/macOS)
@@ -110,8 +110,8 @@ The *json_pp* command tool ships with macOS and can be used as a JSON formatter
110
110
111
111
- Pretty print the JSON output by including `| json_pp` with your GET requests.
112
112
113
-
```console
114
-
curl -i -X GET "{endpoint}documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
113
+
```bash
114
+
curl -i -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>"| json_pp
115
115
```
116
116
117
117
#### [Linux](#tab/linux)
@@ -120,8 +120,8 @@ The *json_pp* command line tool is preinstalled in most Linux distributions. If
120
120
121
121
- Pretty print the JSON output by including `| json_pp` with your `GET` requests.
122
122
123
-
```console
124
-
curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
123
+
```bash
124
+
curl -i -X GET "{endpoint}/documentintelligence/documentModels/{modelId}/analyzeResults/{resultId}?api-version=2024-11-30"-H "Ocp-Apim-Subscription-Key: <subscription key>"| json_pp
125
125
```
126
126
127
127
---
@@ -134,8 +134,8 @@ Before you run the following command, make these changes:
134
134
- Replace *\<DI_KEY* with the variable for your environment variable if it differs from the name in the code.
135
135
- Replace *\<json-tool> with your JSON formatting tool.
0 commit comments