Skip to content

Commit d1f136a

Browse files
authored
Merge pull request #276312 from MicrosoftDocs/main
5/24/2024 AM Publish
2 parents 2b125ea + da1bcdf commit d1f136a

File tree

127 files changed

+801
-600
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+801
-600
lines changed

articles/ai-services/document-intelligence/faq.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
ms.service: azure-ai-document-intelligence
88
ms.custom: references_regions
99
ms.topic: faq
10-
ms.date: 05/13/2024
10+
ms.date: 05/23/2024
1111
ms.author: lajanuar
1212
title: Azure AI Document Intelligence FAQ
1313
summary: |
@@ -30,15 +30,15 @@ sections:
3030
3131
There are no changes to pricing. The names Cognitive Services and Applied AI Services continue to be used in Azure billing, cost analysis, price lists, and price APIs.
3232
33-
There are no breaking changes to APIs or client libraries (SDKs). REST APIs and SDK versions 2024-02-29-preview, 2023-10-31-preview, and later are renamed `document intelligence`.
33+
There are no breaking changes to APIs or client libraries. REST APIs and SDK versions 2024-02-29-preview, 2023-10-31-preview, and going forward are renamed `document intelligence`.
3434
3535
Some platforms are still awaiting the renaming update. In Microsoft documentation, all mentions of Form Recognizer and Document Intelligence refer to the same Azure service.
3636
3737
- question: |
3838
How is Document Intelligence related to document generative AI?
3939
answer: |
4040
41-
You can use a document generative AI solution to chat with your documents, generate captivating content from those documents, and access Azure OpenAI Service models on your data. With Azure AI Document Intelligence and Azure OpenAI combined, you can build an enterprise application to seamlessly interact with your documents by using natural languages, easily find answers and gain valuable insights, and generate new and engaging content from your existing documents. Find more details in the [technical community blog](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/document-generative-ai-the-power-of-azure-ai-document/ba-p/3875015).
41+
You can use a document generative AI solution to chat with your documents, generate captivating content from those documents, and access Azure OpenAI Service models on your data. With Azure AI Document Intelligence and Azure OpenAI combined, you can build an enterprise application to seamlessly interact with your documents. Find more details in the [technical community blog](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/document-generative-ai-the-power-of-azure-ai-document/ba-p/3875015).
4242
4343
- question: |
4444
How is Document Intelligence related to retrieval-augmented generation?
@@ -158,7 +158,7 @@ sections:
158158
What is a bounding box?
159159
answer: |
160160
161-
A bounding box (`polygon` in v3.0 and later versions) is an abstract rectangle that surrounds text elements in a document or form. It's used as a reference point for object detection.
161+
A bounding box (`polygon` in v3.0 and later versions) is an abstract rectangle that surrounds text elements in a document used as a reference point for object detection.
162162
163163
The bounding box specifies position by using an x and y coordinate plane presented in an array of four numerical pairs. Each pair represents a corner of the box in the following order: upper left, upper right, lower right, lower left.
164164
@@ -189,35 +189,35 @@ sections:
189189
190190
- Basic
191191
192-
- **Cognitive Services User**: You need this role for a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [Cognitive Services multiple-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to read/write data and is **required to call the API**.
192+
- **Cognitive Services User**: You need this role for a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [Azure Cognitive Services multiple-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to use Document Intelligence Studio.
193193
194194
- Advanced
195195
196-
- **Contributor**: You need this role to create a resource group or a Document Intelligence resource. The Contributor role doesn't allow you to list keys for Cognitive Services and doesn't give you access to use the created resources or storage, it only allows a user to read/write the resource itself. To use Document Intelligence Studio, you still need the Cognitive Services User role.
196+
- **Contributor**: You need this role to create a resource group or a Document Intelligence resource.
197197
198198
For custom model projects, here are the role requirements for user scenarios:
199199
200200
- Basic
201201
202-
- **Cognitive Services User**: You need this role for a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [Cognitive Services multiple-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to read/write data and is **required to call the API**. This role is also the minimum necessary to train a custom model or analyze with trained models.
202+
- **Cognitive Services User**: You need this role for a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [Cognitive Services multiple-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to train a custom model or analyze with trained models.
203203
204204
- **Storage Blob Data Contributor**: You need this role for a storage account to create project and label data.
205205
206206
- Advanced
207207
208208
- **Storage Account Contributor**: You need this role for the storage account to set up cross-origin resource sharing (CORS) settings. It's a one-time effort if you reuse the same storage account.
209209
210-
The Contributor role doesn't allow you to access data in your blob. To use Document Intelligence Studio, you still need the Storage Blob Data Contributor role.
210+
- **Contributor**: You need this role to create a resource group and resources.
211211
212-
- **Contributor**: You need this role to create a resource group and resources. The Contributor role doesn't give you access to use the created resources or storage, it only allows a user to read/write the resource itself. To use Document Intelligence Studio, you still need basic roles.
212+
Having Contributor or Storage Account Contributor role doesn't give you access to use your Document Intelligence resource or storage account if local (key-based) authentication is disabled. You still need the basic roles (Cognitive Services User and Storage Data Blob Contributor) to use the functions on Document Intelligence Studio.
213213
214214
For more information, see [Microsoft Entra built-in roles](../../role-based-access-control/built-in-roles.md) and the sections about Azure role assignments in the [Document Intelligence Studio quickstart](quickstarts/try-document-intelligence-studio.md).
215215
216216
- question: |
217217
I have multiple pages in a document. Why are only two pages analyzed in Document Intelligence Studio?
218218
answer: |
219219
220-
For free-tier (F0) resources, only the first two pages are analyzed whether you're using Document Intelligence Studio, the REST API, or SDKs.
220+
For free-tier (F0) resources, only the first two pages are analyzed whether you're using Document Intelligence Studio, the REST API, or client libraries.
221221
222222
In Document Intelligence Studio, select the **Settings** (gear) button, select the **Resources** tab, and check the price tier that you're using to analyze the documents. If you want to analyze all pages in a document, change to a paid (S0) resource.
223223
@@ -262,9 +262,9 @@ sections:
262262
263263
"Yes. Document Intelligence Studio has separate URL endpoints for sovereign cloud regions:"
264264
265-
- "URL for the Azure US Government cloud (Azure Fairfax): [Document Intelligence Studio US Government](https://formrecognizer.appliedai.azure.us/studio)".
265+
- "URL for the Azure US Government cloud (Azure Fairfax): [Document Intelligence Studio US Government](https://formrecognizer.appliedai.azure.us/studio)."
266266
267-
- "URL Microsoft Azure operated by 21Vianet (Azure in China): [Document Intelligence Studio China](https://formrecognizer.appliedai.azure.cn/studio)".
267+
- "URL Microsoft Azure operated by 21Vianet (Azure China): [Document Intelligence Studio China](https://formrecognizer.appliedai.azure.cn/studio)."
268268
269269
270270
- name: App development
@@ -288,7 +288,7 @@ sections:
288288
- [Python](https://pypi.org/project/azure-ai-formrecognizer/3.2.0/)
289289
290290
- question: |
291-
Where can I find the supported API version for the latest programming language SDKs?
291+
Where can I find the supported API version for the latest programming language client libraries?
292292
answer: |
293293
294294
This table provides links to the latest SDK versions and shows the relationship between supported Document Intelligence SDK and API versions:
@@ -325,7 +325,7 @@ sections:
325325
How can I specify a range of pages to be analyzed in a document?
326326
answer: |
327327
328-
Use the `pages` parameter (supported in v2.1, v3.0, and later versions of the REST API) to specify pages for multiple-page PDF and TIFF documents. Accepted input includes the following ranges:
328+
Use the `pages` parameter (supported in v2.1, v3.0, and later versions of the REST API) and specify pages for multiple-page PDF and TIFF documents. Accepted input includes the following ranges:
329329
330330
- Single pages. For example, if you specify `1, 2`, pages 1 and 2 are processed.
331331
- Finite ranges. For example, if you specify `2-5`, pages 2 to 5 are processed.
@@ -368,7 +368,7 @@ sections:
368368
369369
- When the service analyzes Microsoft Word and HTML files that the read and layout models support, it counts pages in blocks of 3,000 characters each. For example, if your document contains 7,000 characters, the two pages with 3,000 characters each and one page with 1,000 characters add up to a total of three pages.
370370
371-
- When you're using the read or layout model to analyze Microsoft Word, Excel, PowerPoint, and HTML files, embedded or linked images aren't supported. So the service doesn't count them as added images.
371+
- The read and layout models don't support analysis of embedded or linked images in Microsoft Word, Excel, PowerPoint, and HTML files. Therefore, service doesn't count them as added images.
372372
373373
- Training a custom model is always free with Document Intelligence. You're charged only when the service uses a model to analyze a document.
374374
@@ -449,7 +449,7 @@ sections:
449449
450450
Document Intelligence doesn't have an explicit retrain operation. Each train operation generates a new model.
451451
452-
If you find that your model needs retraining, add more samples to your training dataset and train a new model.
452+
If you find that your model needs to retrain, add more samples to your training dataset and train a new model.
453453
454454
- question: |
455455
How many custom models can I compose into a single custom model?
@@ -554,7 +554,7 @@ sections:
554554
555555
[Disconnected containers](../../ai-services/containers/disconnected-containers.md) enable you to use APIs that are disconnected from the internet. [Billing information](../../ai-services/containers/disconnected-container-faq.yml#how-does-billing-work) isn't sent via the internet. Instead, you're charged based on a purchased commitment tier. Currently, disconnected container usage is available for Document Intelligence custom and invoice models.
556556
557-
The model capabilities provided in connected and disconnected containers are the same and are supported by Document Intelligence v2.1.
557+
The Document Intelligence v2.1 model capabilities for connected and disconnected containers are the same.
558558
559559
- question: |
560560
What data do connected containers send to the cloud?
@@ -565,7 +565,7 @@ sections:
565565
For an example of the information that connected containers send to Microsoft for billing, see the [Azure AI container FAQ](../../ai-services/containers/disconnected-container-faq.yml#how-does-billing-work).
566566
567567
- question: |
568-
Why am I receiving the error "Container isn't in a valid state. Subscription validation failed with status 'OutOfQuota' API key is out of quota"?
568+
Why am I receiving the error *Container isn't in a valid state. Subscription validation failed with status 'OutOfQuota' API key is out of quota*?
569569
answer: |
570570
571571
Document Intelligence connected containers send billing information to Azure by using a Document Intelligence resource on your Azure account. You could get this message if the containers can't communicate with the billing endpoint.
@@ -624,7 +624,7 @@ sections:
624624
- question: |
625625
Where can I find more solutions to my Azure AI Document Intelligence questions?
626626
answer: |
627-
[Microsoft Q&A](/answers/topics/azure-form-recognizer.html) is the home for technical questions and answers at Microsoft. You can filter queries that are specific to Document Intelligence.
627+
[Microsoft Q & A](/answers/topics/azure-form-recognizer.html) is the home for technical questions and answers at Microsoft. You can filter queries that are specific to Document Intelligence.
628628
629629
- question: |
630630
What should I do if the service doesn't recognize specific text, or recognizes it incorrectly, when I'm labeling documents?

0 commit comments

Comments
 (0)