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
> * There are separate URLs for Document Intelligence Studio sovereign cloud regions.
36
-
> * Azure for US Government: [Document Intelligence Studio (Azure Fairfax cloud)](https://formrecognizer.appliedai.azure.us/studio)
37
-
> * Microsoft Azure operated by 21Vianet: [Document Intelligence Studio (Azure in China)](https://formrecognizer.appliedai.azure.cn/studio)
38
33
39
-
[Document Intelligence Studio](https://documentintelligence.ai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the Document Intelligence Studio to:
40
34
41
-
* Learn more about the different capabilities in Document Intelligence.
42
-
* Use your Document Intelligence resource to test models on sample documents or upload your own documents.
43
-
* Experiment with different add-on and preview features to adapt the output to your needs.
44
-
* Train custom classification models to classify documents.
45
-
* Train custom extraction models to extract fields from documents.
46
-
* Get sample code for the language-specific `SDKs` to integrate into your applications.
47
35
48
-
Use the [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md) to get started analyzing documents with document analysis or prebuilt models. Build custom models and reference the models in your applications using one of the [language specific `SDKs`](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and other quickstarts.
49
36
50
37
## Getting started
51
38
52
39
If you're visiting the Studio for the first time, follow the [getting started guide](studio-overview.md#get-started) to set up the Studio for use.
53
40
54
-
## Analyze options
55
41
56
-
* Document Intelligence supports sophisticated analysis capabilities. The Studio allows one entry point (Analyze options button) for configuring the add-on capabilities with ease.
57
-
* Depending on the document extraction scenario, configure the analysis range, document page range, optional detection, and premium detection features.
58
42
59
-
:::image type="content" source="media/studio/analyze-options.png" alt-text="Screenshot of the analyze-options dialog window.":::
60
43
61
-
> [!NOTE]
62
-
> Font extraction is not visualized in Document Intelligence Studio. However, you can check the styles section of the JSON output for the font detection results.
63
-
64
-
✔️ **Auto labeling documents with prebuilt models or one of your own models**
65
-
66
-
* In custom extraction model labeling page, you can now auto label your documents using one of Document Intelligent Service prebuilt models or your trained models.
67
-
68
-
:::image type="content" source="media/studio/auto-label.gif" alt-text="Animated screenshot showing auto labeling in Studio.":::
69
-
70
-
* For some documents, duplicate labels after running autolabel are possible. Make sure to modify the labels so that there are no duplicate labels in the labeling page afterwards.
71
-
72
-
:::image type="content" source="media/studio/duplicate-labels.png" alt-text="Screenshot showing duplicate label warning after auto labeling.":::
73
-
74
-
✔️ **Auto labeling tables**
75
-
76
-
* In custom extraction model labeling page, you can now auto label the tables in the document without having to label the tables manually.
77
-
78
-
:::image type="content" source="media/studio/auto-table-label.gif" alt-text="Animated screenshot showing auto table labeling in Studio.":::
79
-
80
-
✔️ **Add test files directly to your training dataset**
81
-
82
-
* Once you train a custom extraction model, make use of the test page to improve your model quality by uploading test documents to training dataset if needed.
83
-
84
-
* If a low confidence score is returned for some labels, make sure they're correctly labeled. If not, add them to the training dataset and relabel to improve the model quality.
85
-
86
-
:::image type="content" source="media/studio/add-from-test.gif" alt-text="Animated screenshot showing how to add test files to training dataset.":::
87
-
88
-
✔️ **Make use of the document list options and filters in custom projects**
89
-
90
-
* Use the custom extraction model labeling page to navigate through your training documents with ease by making use of the search, filter, and sort by feature.
91
-
92
-
* Utilize the grid view to preview documents or use the list view to scroll through the documents more easily.
93
-
94
-
:::image type="content" source="media/studio/document-options.png" alt-text="Screenshot of document list view options and filters.":::
95
-
96
-
✔️ **Project sharing**
97
-
98
-
* Share custom extraction projects with ease. For more information, see [Project sharing with custom models](how-to-guides/project-share-custom-models.md).
99
-
100
-
## Document Intelligence model support
101
-
102
-
***Read**: Try out Document Intelligence's Read feature to extract text lines, words, detected languages, and handwritten style if detected. Start with the [Studio Read feature](https://documentintelligence.ai.azure.com/studio/read). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Read overview](concept-read.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true).
103
-
104
-
***Layout**: Try out Document Intelligence's Layout feature to extract text, tables, selection marks, and structure information. Start with the [Studio Layout feature](https://documentintelligence.ai.azure.com/studio/layout). Explore with sample documents and your documents. Use the interactive visualization and JSON output to understand how the feature works. See the [Layout overview](concept-layout.md) to learn more and get started with the [Python SDK quickstart for Layout](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#layout-model).
105
-
106
-
***Prebuilt models**: Document Intelligence's prebuilt models enable you to add intelligent document processing to your apps and flows without having to train and build your own models. As an example, start with the [Studio Invoice feature](https://documentintelligence.ai.azure.com/studio/prebuilt?formType=invoice). Explore with sample documents and your documents. Use the interactive visualization, extracted fields list, and JSON output to understand how the feature works. See the [Models overview](concept-model-overview.md) to learn more and get started with the [Python SDK quickstart for Prebuilt Invoice](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true#prebuilt-model).
107
-
108
-
***Custom extraction models**: Document Intelligence's custom models enable you to extract fields and values from models trained with your data, tailored to your forms and documents. To extract data from multiple form types, create standalone custom models or combine two, or more, custom models and create a composed model. Start with the [Studio Custom models feature](https://documentintelligence.ai.azure.com/studio/custommodel/projects). Use the help wizard, labeling interface, training step, and visualizations to understand how the feature works. Test the custom model with your sample documents and iterate to improve the model. To learn more, *see* the [Custom models overview](concept-custom.md) to learn more.
109
-
110
-
***Custom classification models**: Document classification is a new scenario supported by Document Intelligence. the document classifier API supports classification and splitting scenarios. Train a classification model to identify the different types of documents your application supports. The input file for the classification model can contain multiple documents and classifies each document within an associated page range. To learn more, *see*[custom classification models](concept-custom-classifier.md).
111
-
112
-
***Add-on Capabilities**: Document Intelligence now supports more sophisticated analysis capabilities. These optional capabilities can be enabled and disabled in the studio using the `Analze Options` button in each model page. There are four add-on capabilities available: highResolution, formula, font, and barcode extraction capabilities. To learn more, *see*[Add-on capabilities](concept-add-on-capabilities.md).
Copy file name to clipboardExpand all lines: articles/ai-services/document-intelligence/faq.yml
+3-48Lines changed: 3 additions & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -146,58 +146,13 @@ sections:
146
146
147
147
The labeling experience from Document Intelligence Studio is open sourced in the [Toolkit repo](https://github.com/microsoft/Form-Recognizer-Toolkit).
148
148
149
-
- question: |
150
-
Why am I receiving the error "Form Recognizer Not Found" when opening my custom project?
151
-
answer: |
152
-
Your Document Intelligence resource bound to this custom project was deleted or moved to another resource group. There are two ways to resolve this problem:
153
-
154
-
- Re-create the Document Intelligence resource under the same subscription and resource group with the same name.
155
-
156
-
- Re-create a custom project with the migrated Document Intelligence resource and specify the same storage account.
157
-
158
-
- question: |
159
-
Why an I receiving the error "PermissionDenied" when using prebuilt apps or opening my custom project?
160
-
answer: |
161
-
If you received error "PermissionDenied: Principal does not have access to API/Operation" when analyzing against prebuilt models or opening a custom project, it is likely the local (key-based) authentication is disabled for your Document Intelligence resource and your do not have enough permission to access the resource. Please reference [Azure role assignments](quickstarts/try-document-intelligence-studio.md#azure-role-assignments) to configure your access roles.
162
-
163
-
- question: |
164
-
Why an I receiving the error "AuthorizationPermissionMismatch" when opening my custom project?
165
-
answer: |
166
-
If you received error "AuthorizationPermissionMismatch: This request is not authorized to perform this operation using this permission" when opening a custom project, it is likely the local (key-based) authentication is disabled for your storage account and your do not have enough permission to access the blob data. Please reference [Azure role assignments](quickstarts/try-document-intelligence-studio.md#azure-role-assignments-1) to configure your access roles.
167
-
168
-
- question: |
169
-
Why am I not able to sign in to Document Intelligence Studio and keeps seeing InteractionRequiredAuthError error (AADSTS50058)?
170
-
answer: |
171
-
If you received error "InteractionRequiredAuthError: login_required: AADSTS50058: A silent sign-request was sent but no user is signed in.", this is due to 3rd-party cookies are blocked by your browser so we cannot successfully sign in your account.
172
-
173
-
For **Edge** users, please:
174
-
- Go to **Settings** for Edge
175
-
- Search for "**third-party**"
176
-
- Go to **Manage and delete cookies and site data**
177
-
- Turn off the setting of **Block third-party cookies**
178
-
179
-
For **Chrome** users, please:
180
-
- Go to **Settings** for Chrome
181
-
- Search for "**Third-party**"
182
-
- Under **Default behavior**, select **Allow third-party cookies**
183
-
184
-
For **Firefox** users, please:
185
-
- Go to **Settings** for Firefox
186
-
- Search for "**cookies**"
187
-
- Under **Enhanced Tracking Protection**, select **Manage Exceptions**
188
-
- Add exception for **https://documentintelligence.ai.azure.com** or the Document Intelligence Studio URL of your environment
189
-
190
-
For **Safari** users, please:
191
-
- Choose **Safari** > **Preferences**
192
-
- Click **Privacy**
193
-
- Deselect **Block all cookies**
194
-
195
-
196
149
- question: |
197
150
Are there separate URL endpoints for Document Intelligence sovereign cloud regions?
198
151
answer: |
199
152
200
-
"Yes. Document Intelligence Studio has separate URL endpoints for sovereign cloud regions:"
153
+
Yes.
154
+
155
+
"Document Intelligence Studio has separate URL endpoints for sovereign cloud regions:"
201
156
202
157
- "URL for the Azure US Government cloud (Azure Fairfax): [Document Intelligence Studio US Government](https://formrecognizer.appliedai.azure.us/studio)."
To use Document Intelligence Studio, you need the following assets and settings:
28
+
27
29
* An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/). If you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/).
30
+
28
31
* A [**Document Intelligence**](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [**multi-service**](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource.
29
32
30
33
> [!TIP]
31
34
> Create an Azure AI services resource if you plan to access multiple Azure AI services under a single endpoint/key. For Document Intelligence access only, create a Document Intelligence resource. Please note that you'll need a single-service resource if you intend to use [Microsoft Entra authentication](../../../active-directory/authentication/overview-authentication.md).
32
35
>
33
36
> Document Intelligence now supports AAD token authentication additional to local (key-based) authentication when accessing the Document Intelligence resources and storage accounts. Be sure to follow below instructions to setup correct access roles, especially if your resources are applied with `DisableLocalAuth` policy.
34
37
35
-
#### Azure role assignments
38
+
***Properly scoped Azure role assignments** For document analysis and prebuilt models, following role assignments are required for different scenarios.
36
39
37
-
For document analysis and prebuilt models, following role assignments are required for different scenarios.
40
+
* Basic
41
+
✔️ **Cognitive Services User**: you need this role to Document Intelligence or Azure AI services resource to enter the analyze page.
38
42
39
-
* Basic
40
-
***Cognitive Services User**: you need this role to Document Intelligence or Azure AI services resource to enter the analyze page.
41
-
* Advanced
42
-
***Contributor**: you need this role to create resource group, Document Intelligence service, or Azure AI services resource.
43
+
* Advanced
44
+
✔️ **Contributor**: you need this role to create resource group, Document Intelligence service, or Azure AI services resource.
43
45
44
-
For more information on authorization, *see*[Document Intelligence Studio authorization policies](../studio-overview.md#authorization-policies).
46
+
For more information on authorization, *see*[Document Intelligence Studio authorization policies](../studio-overview.md#authorization-policies).
45
47
46
-
> [!NOTE]
47
-
> If local (key-based) authentication is disabled for your Document Intelligence service resource, be sure to obtain **Cognitive Services User** role and your AAD token will be used to authenticate requests on Document Intelligence Studio. The **Contributor** role only allows you to list keys but does not give you permission to use the resource when key-access is disabled.
48
+
> [!NOTE]
49
+
> If local (key-based) authentication is disabled for your Document Intelligence service resource, be sure to obtain **Cognitive Services User** role and your AAD token will be used to authenticate requests on Document Intelligence Studio. The **Contributor** role only allows you to list keys but does not give you permission to use the resource when key-access is disabled.
50
+
51
+
* Once your resource is configured, you can try the different models offered by Document Intelligence Studio. From the front page, select any Document Intelligence model to try using with a no-code approach.
52
+
53
+
* To test any of the document analysis or prebuilt models, select the model and use one of the sample documents or upload your own document to analyze. The analysis result is displayed at the right in the content-result-code window.
54
+
55
+
* Custom models need to be trained on your documents. See [custom models overview](concept-custom.md) for an overview of custom models.
56
+
57
+
## Authentication
58
+
59
+
Navigate to the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/). If it's your first time logging in, a popup window appears prompting you to configure your service resource. In accordance with your organization's policy, you have one or two options:
60
+
61
+
***Microsoft Entra authentication: access by Resource (recommended)**.
62
+
63
+
* Choose your existing subscription.
64
+
* Select an existing resource group within your subscription or create a new one.
65
+
* Select your existing Document Intelligence or Azure AI services resource.
66
+
67
+
:::image type="content" source="media/studio/configure-service-resource.png" alt-text="Screenshot of configure service resource form from the Document Intelligence Studio.":::
68
+
69
+
***Local authentication: access by API endpoint and key**.
70
+
71
+
* Retrieve your endpoint and key from the Azure portal.
72
+
* Go to the overview page for your resource and select **Keys and Endpoint** from the left navigation bar.
73
+
* Enter the values in the appropriate fields.
74
+
75
+
:::image type="content" source="media/studio/keys-and-endpoint.png" alt-text="Screenshot of the keys and endpoint page in the Azure portal.":::
76
+
77
+
* After validating the scenario in the Document Intelligence Studio, use the [**C#**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**Java**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true), or [**Python**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) client libraries or the [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) to get started incorporating Document Intelligence models into your own applications.
78
+
79
+
To learn more about each model, *see* our concept pages.
80
+
81
+
### View resource details
82
+
83
+
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.
0 commit comments