Skip to content

Commit 1630ea7

Browse files
committed
update quickstart
1 parent c90369f commit 1630ea7

File tree

6 files changed

+26
-24
lines changed

6 files changed

+26
-24
lines changed

articles/ai-services/document-intelligence/model-overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ ms.author: lajanuar
4848

4949
The following table shows the available models for each stable API:
5050

51-
|**Model Type**| **Model**|• [2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)|[v2.1 (GA)](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)|
51+
|**Model Type**| **Model**|[2024-11-30 (GA)](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-11-30)&preserve-view=true)|[2023-07-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)|[2022-08-31 (GA)](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)|[v2.1 (GA)](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)|
5252
|----------------|-----------|---|--|---|---|
5353
|Document analysis models|[Read](prebuilt/read.md) | ✔️| ✔️| ✔️| n/a|
5454
|Document analysis models|[Layout](prebuilt/layout.md) | ✔️| ✔️| ✔️| ✔️|
55-
|Document analysis models|[General document](prebuilt/general-document.md) |**supported in<br>layout model**| ✔️| ✔️| n/a|
55+
|Document analysis models|[** General document](prebuilt/general-document.md) |**supported in<br>layout model**| ✔️| ✔️| n/a|
5656
|Prebuilt models|[Bank Check](concept-bank-check.md) | ✔️| n/a| n/a| n/a|
5757
|Prebuilt models|[Bank Statement](concept-bank-statement.md) | ✔️| n/a| n/a| n/a|
5858
|Prebuilt models|[Paystub](concept-pay-stub.md) | ✔️| n/a| n/a| n/a|
@@ -82,8 +82,8 @@ The following table shows the available models for each stable API:
8282
|Custom extraction model|[Custom composed](train/composed-models.md) | ✔️| ✔️| ✔️| ✔️|
8383
|All models|[Add-on capabilities](concept-add-on-capabilities.md) | ✔️| ✔️| n/a| n/a|
8484

85-
\* - Contains submodels. See the model specific information for supported variations and subtypes.</br>
86-
\**- All the General Document model capabilities are available in layout model. General model is no longer supported.
85+
\* Contains submodels. See the model specific information for supported variations and subtypes.</br>
86+
\** All the General Document model capabilities are available in layout model. General model is no longer supported.
8787

8888
### Latency
8989

@@ -410,7 +410,7 @@ A composed model is created by taking a collection of custom models and assignin
410410
[!INCLUDE [input requirements](./includes/input-requirements.md)]
411411

412412
> [!NOTE]
413-
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from tool not the Document Intelligence Service.
413+
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from the tool not the Document Intelligence Service.
414414
415415
### Version migration
416416

@@ -531,7 +531,7 @@ A composed model is created by taking a collection of custom models and assignin
531531
[!INCLUDE [input requirements](./includes/input-requirements.md)]
532532

533533
> [!NOTE]
534-
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from tool not the Document Intelligence Service.
534+
> The [Sample Labeling tool](https://fott-2-1.azurewebsites.net/) doesn't support the BMP file format. The limitation is derived from the tool not the Document Intelligence Service.
535535
536536
### Version migration
537537

articles/ai-services/document-intelligence/prebuilt/layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ See how data, including text, tables, table headers, selection marks, and struct
8686

8787
:::image type="content" source="../media/containers/keys-and-endpoint.png" alt-text="Screenshot of keys and endpoint location in the Azure portal.":::
8888

89-
After you retrieve you key and endpoint, you can use the following development options to build and deploy your Document Intelligence applications:
89+
After you retrieve your key and endpoint, use the following development options to build and deploy your Document Intelligence applications:
9090

9191
### [REST API](#tab/rest)
9292

@@ -220,7 +220,7 @@ The new machine-learning based page object detection extracts logical roles like
220220

221221
### Text, lines, and words
222222

223-
The document layout model in Document Intelligence extracts print and handwritten style text as `lines` and `words`. The `styles` collection ../includes any handwritten style for lines if detected along with the spans pointing to the associated text. This feature applies to [supported handwritten languages](../language-support/prebuilt.md).
223+
The document layout model in Document Intelligence extracts print and handwritten style text as `lines` and `words`. The `styles` collection includes any handwritten style for lines if detected along with the spans pointing to the associated text. This feature applies to [supported handwritten languages](../language-support/prebuilt.md).
224224

225225
For Microsoft Word, Excel, PowerPoint, and HTML, Document Intelligence v4.0 `2024-11-30` (GA) Layout model extract all embedded text as is. Texts are extracted as words and paragraphs. Embedded images aren't supported.
226226

articles/ai-services/document-intelligence/quickstarts/get-started-studio.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: "Quickstart: Document intelligence Studio"
2+
title: "Quickstart: Document Intelligence Studio"
33
titleSuffix: Azure AI Services
4-
description: How to get started processing forms and documents using Document intelligence Studio
4+
description: How to get started processing forms and documents using Document Intelligence Studio
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
@@ -13,11 +13,11 @@ monikerRange: '>=doc-intel-3.0.0'
1313

1414
<!-- markdownlint-disable MD001 -->
1515

16-
# Get started: Document intelligence Studio
16+
# Get started: Document Intelligence Studio
1717

18-
[Document intelligence Studio](https://formrecognizer.appliedai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document intelligence service in your applications. You can get started by exploring the pretrained models with sample or your own documents. You can also create projects to build custom template models and reference the models in your applications.
18+
[Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service in your applications. You can get started by exploring the pretrained models with sample or your own documents. You can also create projects to build custom template models and reference the models in your applications.
1919

20-
> [!VIDEO https://www.microsoft.com/en-us/videoplayer/embed/RE56n49]
20+
> [!VIDEO https://www.microsoft.com/videoplayer/embed/RE56n49]
2121
2222
## Prerequisites for new users
2323

@@ -56,11 +56,11 @@ For more information, *see* the following guidance:
5656

5757
> [!IMPORTANT]
5858
>
59-
> * Make sure you have the **Cognitive Services User role**, and not the Cognitive Services Contributor role when setting up Entra authentication.
59+
> * Make sure you have the **Cognitive Services User role**, and not the Cognitive Services Contributor role when setting up Microsoft Entra ID authentication.
6060
> * ✔️ **Cognitive Services User**: you need this role to Document Intelligence or Azure AI services resource to enter the analyze page.
6161
> * ✔️ **Contributor**: you need this role to create resource group, Document Intelligence service, or Azure AI services resource.
6262
> * In Azure context, Contributor role can only perform actions to control and manage the resource itself, including listing the access keys.
63-
> * User accounts with a Contributor are only able to access the Document Intelligence service by calling with access keys. However, when setting up access with Entra ID, key-access is disabled and **Cognitive Service User** role is required for an account to use the resources.
63+
> * User accounts with a Contributor are only able to access the Document Intelligence service by calling with access keys. However, when setting up access with Microsoft Entra ID, key-access is disabled and **Cognitive Services User** role is required for an account to use the resources.
6464
6565
### Authentication in Studio
6666

@@ -72,15 +72,15 @@ Navigate to the [Document Intelligence Studio](https://formrecognizer.appliedai.
7272
* Select an existing resource group within your subscription or create a new one.
7373
* Select your existing Document Intelligence or Azure AI services resource.
7474

75-
:::image type="content" source="../media/studio/configure-service-resource.png" alt-text="Screenshot of configure service resource form from the Document Intelligence Studio.":::
75+
:::image type="content" source="../media/studio/configure-service-resource.png" lightbox="../media/studio/configure-service-resource.png" alt-text="Screenshot of configure service resource form from the Document Intelligence Studio.":::
7676

7777
* **Local authentication: access by API endpoint and key**.
7878

7979
* Retrieve your endpoint and key from the Azure portal.
8080
* Go to the overview page for your resource and select **Keys and Endpoint** from the left navigation bar.
8181
* Enter the values in the appropriate fields.
8282

83-
:::image type="content" source="../media/studio/keys-and-endpoint.png" alt-text="Screenshot of the keys and endpoint page in the Azure portal.":::
83+
:::image type="content" source="../media/studio/keys-and-endpoint.png" lightbox="../media/studio/keys-and-endpoint.png" alt-text="Screenshot of the keys and endpoint page in the Azure portal.":::
8484

8585
* After validating the scenario in the Document Intelligence Studio, use the [**C#**](get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true), [**Java**](get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true), [**JavaScript**](get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true), or [**Python**](get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true) client libraries or the [**REST API**](get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true) to get started incorporating Document Intelligence models into your own applications.
8686

@@ -114,7 +114,7 @@ Use the help wizard, labeling interface, training step, and interactive visualiz
114114

115115
To view resource details such as name and pricing tier, select the **Settings** icon in the top-right corner of the Document Intelligence Studio home page and select the **Resource** tab. If you have access to other resources, you can switch resources as well.
116116

117-
:::image type="content" source="../media/studio/form-recognizer-studio-resource-page.png" alt-text="Screenshot of the studio settings page resource tab.":::
117+
:::image type="content" source="../media/studio/form-recognizer-studio-resource-page.png" lightbox="../media/studio/form-recognizer-studio-resource-page.png" alt-text="Screenshot of the studio settings page resource tab.":::
118118

119119
With Document Intelligence, you can quickly automate your data processing in applications and workflows, easily enhance data-driven strategies, and skillfully enrich document search capabilities.
120120

@@ -123,15 +123,15 @@ With Document Intelligence, you can quickly automate your data processing in app
123123
**Edge**:
124124

125125
* Go to **Settings** for Microsoft Edge
126-
* Search for "**third*party**"
126+
* Search for "**third-party**"
127127
* Go to **Manage and delete cookies and site data**
128-
* Turn off the setting of **Block third*party cookies**
128+
* Turn off the setting of **Block third-party cookies**
129129

130130
**Chrome**:
131131

132132
* Go to **Settings** for Chrome
133133
* Search for "**Third*party**"
134-
* Under **Default behavior**, select **Allow third*party cookies**
134+
* Under **Default behavior**, select **Allow third-party cookies**
135135

136136
**Firefox**:
137137

@@ -151,7 +151,7 @@ With Document Intelligence, you can quickly automate your data processing in app
151151
|Scenario |Cause| Resolution|
152152
|-------------|------|----------|
153153
|You receive the error message</br> `Form Recognizer Not Found` when opening a custom project.|Your Document Intelligence resource, bound to the custom project was deleted or moved to another resource group.| There are two ways to resolve this problem: </br>&bullet; Re-create the Document Intelligence resource under the same subscription and resource group with the same name.</br>&bullet; Re-create a custom project with the migrated Document Intelligence resource and specify the same storage account.|
154-
|You receive the error message</br> `PermissionDenied` when using prebuilt apps or opening a custom project.|The principal doesn't have access to API/Operation" when analyzing against prebuilt models or opening a custom project. It's likely the local (key-based) authentication is disabled for your Document Intelligence resource don't have enough permission to access the resource.|Reference [Azure role assignments](try-document-intelligence-studio.md#azure-role-assignments) to configure your access roles.|
154+
|You receive the error message</br> `PermissionDenied` when using prebuilt apps or opening a custom project.|The principal doesn't have access to API/Operation when analyzing against prebuilt models or opening a custom project. It's likely the local (key-based) authentication is disabled for your Document Intelligence resource don't have enough permission to access the resource.|Reference [Azure role assignments](try-document-intelligence-studio.md#azure-role-assignments) to configure your access roles.|
155155
|You receive the error message</br> `AuthorizationPermissionMismatch` when opening a custom project.|The request isn't authorized to perform the operation using the designated permission. It's likely the local (key-based) authentication is disabled for your storage account and you don't have the granted permission to access the blob data.|Reference [Azure role assignments](try-document-intelligence-studio.md#azure-role-assignments) to configure your access roles.|
156156
|You can't sign in to Document Intelligence Studio and receive the error message</br> `InteractionRequiredAuthError:login_required:AADSTS50058:A silent sign-request was sent but no user is signed in`|It's likely that your browser is blocking third-party cookies so you can't successfully sign in.|To resolve, see [Manage third-party settings](#manage-third-party-settings-for-studio-access) for your browser.|
157157

articles/ai-services/document-intelligence/quickstarts/studio-custom-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For custom projects, the following role assignments are required for different s
4747
* **Contributor**: You need this role to create a resource group and resources.
4848

4949
> [!NOTE]
50-
> If local (key-based) authentication is disabled for your Document Intelligence service resource and storage account, be sure to obtain **Cognitive Services User** and **Storage Blob Data Contributor** roles respectively, so you have enough permissions to use Document Intelligence Studio. The **Storage Account Contributor** and **Contributor** roles only allow you to list keys but doesn't give you permission to use the resources when key-access is disabled.
50+
> If local (key-based) authentication is disabled for your Document Intelligence service resource and storage account, be sure to obtain **Cognitive Services User** and **Storage Blob Data Contributor** roles respectively, so you have enough permissions to use Document Intelligence Studio. The **Storage Account Contributor** and **Contributor** roles only allow you to list keys but don't give you permission to use the resources when key-access is disabled.
5151
5252
### Configure CORS
5353

articles/ai-services/document-intelligence/studio-overview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: overview
9-
ms.date: 02/27/2025
9+
ms.date: 03/18/2025
1010
ms.author: lajanuar
1111
monikerRange: '>=doc-intel-3.0.0'
1212
---
@@ -27,6 +27,8 @@ The studio is an online tool to visually explore, understand, train, and integra
2727
* Train custom extraction models to extract fields from documents.
2828
* Get sample code for the language specific `SDKs` to integrate into your applications.
2929

30+
:::image type="content" source="media/studio/home-page.png" alt-text="Screenshot of Document Intelligence Studio home page.":::
31+
3032
Currently, we're undergoing the migration of features from the [Document Intelligence Studio](https://documentintelligence.ai.azure.com/studio) to the new [Azure AI Foundry portal](https://ai.azure.com/explore/aiservices/vision). There are some differences in the offerings for the two studios, which determine the correct studio for your use case.
3133

3234
## Choosing the correct studio experience

0 commit comments

Comments
 (0)