Skip to content

Commit 9881c0d

Browse files
committed
edit pass: azure-ai-document-intelligence
1 parent bd88e8f commit 9881c0d

File tree

2 files changed

+231
-250
lines changed

2 files changed

+231
-250
lines changed

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

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -46,33 +46,33 @@ ms.custom: sfi-image-nochange
4646
4747
## Model overview
4848

49-
The following table shows the available models for each stable API.
49+
The following table shows the generally available (GA) models for each stable API.
5050

5151
|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) | ✔️| ✔️| ✔️| Not available|
5454
|Document analysis models|[Layout](prebuilt/layout.md) | ✔️| ✔️| ✔️| ✔️|
5555
|Document analysis models|[General document**](prebuilt/general-document.md) |Supported in<br>layout model| ✔️| ✔️| Not available|
56-
|Prebuilt models|[Bank Check](concept-bank-check.md) | ✔️| Not available| Not available| Not available|
57-
|Prebuilt models|[Bank Statement](concept-bank-statement.md) | ✔️| Not available| Not available| Not available|
58-
|Prebuilt models|[Paystub](concept-pay-stub.md) | ✔️| Not available| Not available| Not available|
56+
|Prebuilt models|[Bank check](concept-bank-check.md) | ✔️| Not available| Not available| Not available|
57+
|Prebuilt models|[Bank statement](concept-bank-statement.md) | ✔️| Not available| Not available| Not available|
58+
|Prebuilt models|[payStub](concept-pay-stub.md) | ✔️| Not available| Not available| Not available|
5959
|Prebuilt models|[Contract](prebuilt/contract.md) | ✔️| ✔️| Not available| Not available|
6060
|Prebuilt models|[Health insurance card](prebuilt/health-insurance-card.md)| ✔️| ✔️| ✔️| Not available|
6161
|Prebuilt models|[ID document](prebuilt/id-document.md) | ✔️| ✔️| ✔️| ✔️|
6262
|Prebuilt models|[Invoice](prebuilt/invoice.md) | ✔️| ✔️| ✔️| ✔️|
6363
|Prebuilt models|[Receipt](prebuilt/receipt.md) | ✔️| ✔️| ✔️| ✔️|
64-
|Prebuilt models|[US Unified Tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
65-
|Prebuilt models|[US 1040 Tax*](prebuilt/tax-document.md) | ✔️| ✔️| Not available| Not available|
66-
|Prebuilt models|[US 1095 Tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
67-
|Prebuilt models|[US 1098 Tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
68-
|Prebuilt models|[US 1099 Tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
69-
|Prebuilt models|[US W2 Tax](prebuilt/tax-document.md) | ✔️| ✔️| ✔️| Not available|
70-
|Prebuilt models|[US W4 Tax](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
71-
|Prebuilt models|[US Mortgage 1003 URLA](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
72-
|Prebuilt models|[US Mortgage 1004 URAR](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
73-
|Prebuilt models|[US Mortgage 1005](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
74-
|Prebuilt models|[US Mortgage 1008 Summary](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
75-
|Prebuilt models|[US Mortgage closing disclosure](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
64+
|Prebuilt models|[US unified tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
65+
|Prebuilt models|[US 1040 tax*](prebuilt/tax-document.md) | ✔️| ✔️| Not available| Not available|
66+
|Prebuilt models|[US 1095 tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
67+
|Prebuilt models|[US 1098 tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
68+
|Prebuilt models|[US 1099 tax*](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
69+
|Prebuilt models|[US W2 tax](prebuilt/tax-document.md) | ✔️| ✔️| ✔️| Not available|
70+
|Prebuilt models|[US W4 tax](prebuilt/tax-document.md) | ✔️| Not available| Not available| Not available|
71+
|Prebuilt models|[US mortgage 1003 URLA](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
72+
|Prebuilt models|[US mortgage 1004 URAR](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
73+
|Prebuilt models|[US mortgage 1005](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
74+
|Prebuilt models|[US mortgage 1008 summary](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
75+
|Prebuilt models|[US mortgage closing disclosure](concept-mortgage-documents.md) | ✔️| Not available| Not available| Not available|
7676
|Prebuilt models|[Marriage certificate](concept-marriage-certificate.md) | ✔️| Not available| Not available| Not available|
7777
|Prebuilt models|[Credit card](concept-credit-card.md) | ✔️| Not available| Not available| Not available|
7878
|Prebuilt models|[Business card](concept-business-card.md) | deprecated|✔️|✔️|✔️ |
@@ -83,15 +83,15 @@ The following table shows the available models for each stable API.
8383
|All models|[Add-on capabilities](concept-add-on-capabilities.md) | ✔️| ✔️| Not available| Not available|
8484

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

8888
### Latency
8989

90-
Latency is the amount of time it takes for an API server to handle and process an incoming request and deliver the outgoing response to the client. The time to analyze a document depends on the size (for example, number of pages) and associated content on each page. Document Intelligence is a multitenant service where latency for similar documents is comparable but not always identical. Occasional variability in latency and performance is inherent in any microservice-based, stateless, asynchronous service that processes images and large documents at scale. Although we're continuously scaling up the hardware and capacity and scaling capabilities, you might still have latency issues at runtime.
90+
Latency is the amount of time it takes for an API server to handle and process an incoming request and deliver the outgoing response to the client. The time to analyze a document depends on the size (for example, number of pages) and associated content on each page. Document Intelligence is a multitenant asynchronous service where latency for similar documents is comparable but not always identical. Occasional variability in latency and performance is inherent in any microservice-based, stateless service that processes images and large documents at scale. Although we're continuously scaling up the hardware and capacity and scaling capabilities, you might still have latency issues at runtime.
9191

9292
### Add-on capability
9393

94-
The following add-on capabilities are available for Document Intelligence. For all models except the Business card model, Document Intelligence now supports add-on capabilities to allow for more sophisticated analysis. You can enable and disable these optional capabilities depending on the scenario of the document extraction. Seven add-on capabilities are available for the 2023-07-31 (GA) and later API version:
94+
The following add-on capabilities are available for Document Intelligence. For all models except the business card model, Document Intelligence now supports add-on capabilities to allow for more sophisticated analysis. You can enable and disable these optional capabilities depending on the scenario of the document extraction. Seven add-on capabilities are available for the 2023-07-31 (GA) and later API version:
9595

9696
* [`ocrHighResolution`](concept-add-on-capabilities.md#high-resolution-extraction)
9797
* [`formulas`](concept-add-on-capabilities.md#formula-extraction)
@@ -157,7 +157,7 @@ This sample document was processed by using [Document Intelligence Studio](https
157157
:::image type="content" source="media/studio/form-recognizer-studio-read-v3p2.png" alt-text="Screenshot that shows a sample document processed by using Document Intelligence Studio Read.":::
158158

159159
> [!div class="nextstepaction"]
160-
> [Learn more: read model](prebuilt/read.md)
160+
> [Learn more: Read model](prebuilt/read.md)
161161
162162
### Layout analysis
163163

@@ -171,7 +171,7 @@ This sample document was processed by using [Document Intelligence Studio](https
171171

172172
> [!div class="nextstepaction"]
173173
>
174-
> [Learn more: layout model](prebuilt/layout.md)
174+
> [Learn more: Layout model](prebuilt/layout.md)
175175
176176
### Health insurance card
177177

@@ -217,8 +217,8 @@ The US mortgage document models analyze and extract key fields that include borr
217217

218218
|Model|Description|Model ID|
219219
|---|---|---|
220-
|1003 End-User License Agreement (EULA)|Extract loan, borrower, property details.|`prebuilt-mortgage.us.1003`|
221-
|1004 Uniform Residential Appraisal Report (URAR))|Extract loan, borrower, property details.|`prebuilt-mortgage.us.1004`|
220+
|1003 End-User License Agreement|Extract loan, borrower, property details.|`prebuilt-mortgage.us.1003`|
221+
|1004 Uniform Residential Appraisal Report (URAR)|Extract loan, borrower, property details.|`prebuilt-mortgage.us.1004`|
222222
|1005 Verification of employment|Extract loan, borrower, property details.|`prebuilt-mortgage.us.1005`|
223223
|1008 Summary document|Extract borrower, seller, property, mortgage, and underwriting details.|`prebuilt-mortgage.us.1008`|
224224
|Closing Disclosure|Extract closing, transaction costs, and loan details.|`prebuilt-mortgage.us.closingDisclosure`|
@@ -241,7 +241,7 @@ This sample contract was processed by using [Document Intelligence Studio](https
241241
:::image type="content" source="media/studio/analyze-contract.png" alt-text="Screenshot that shows contract model extraction using Document Intelligence Studio.":::
242242

243243
> [!div class="nextstepaction"]
244-
> [Learn more: contract model](prebuilt/contract.md)
244+
> [Learn more: Contract model](prebuilt/contract.md)
245245
246246
### US bank check
247247

@@ -254,7 +254,7 @@ This bank check sample was processed by using [Document Intelligence Studio](htt
254254
:::image type="content" source="media/studio/analyze-bank-check.png" alt-text="Screenshot that shows bank check model extraction by using Document Intelligence Studio.":::
255255

256256
> [!div class="nextstepaction"]
257-
> [Learn more: contract model](prebuilt/bank-check.md)
257+
> [Learn more: Contract model](prebuilt/bank-check.md)
258258
259259
### US bank statement
260260

@@ -267,7 +267,7 @@ This sample bank statement was processed by using [Document Intelligence Studio]
267267
:::image type="content" source="media/studio/analyze-bank-statement.png" alt-text="Screenshot that shows bank statement model extraction by using Document Intelligence Studio.":::
268268

269269
> [!div class="nextstepaction"]
270-
> [Learn more: contract model](prebuilt/bank-statement.md)
270+
> [Learn more: Contract model](prebuilt/bank-statement.md)
271271
272272
### payStub
273273

@@ -280,7 +280,7 @@ This sample pay stub was processed by using [Document Intelligence Studio](https
280280
:::image type="content" source="media/studio/analyze-pay-stub.png" alt-text="Screenshot that shows payStub model extraction by using Document Intelligence Studio.":::
281281

282282
> [!div class="nextstepaction"]
283-
> [Learn more: contract model](prebuilt/pay-stub.md)
283+
> [Learn more: Contract model](prebuilt/pay-stub.md)
284284
285285
### Invoice
286286

@@ -293,7 +293,7 @@ This sample invoice was processed by using [Document Intelligence Studio](https:
293293
:::image type="content" source="./media/studio/analyze-invoice.png" alt-text="Screenshot that shows a sample invoice." lightbox="./media/overview-invoices.jpg":::
294294

295295
> [!div class="nextstepaction"]
296-
> [Learn more: invoice model](prebuilt/invoice.md)
296+
> [Learn more: Invoice model](prebuilt/invoice.md)
297297
298298
### Receipt
299299

@@ -306,7 +306,7 @@ This sample receipt was processed by using [Document Intelligence Studio](https:
306306
:::image type="content" source="./media/studio/analyze-receipt.png" alt-text="Screenshot that shows a sample receipt." lightbox="./media/overview-receipt.jpg":::
307307

308308
> [!div class="nextstepaction"]
309-
> [Learn more: receipt model](prebuilt/receipt.md)
309+
> [Learn more: Receipt model](prebuilt/receipt.md)
310310
311311
### Identity document
312312

@@ -319,7 +319,7 @@ This sample US driver's license was processed by using [Document Intelligence St
319319
:::image type="content" source="./media/studio/analyze-drivers-license.png" alt-text="Screenshot that shows a sample identification card." lightbox="./media/overview-id.jpg":::
320320

321321
> [!div class="nextstepaction"]
322-
> [Learn more: identity document model](prebuilt/id-document.md)
322+
> [Learn more: Identity document model](prebuilt/id-document.md)
323323
324324
### Marriage certificate
325325

@@ -332,7 +332,7 @@ This sample US marriage certificate was processed by using [Document Intelligenc
332332
:::image type="content" source="./media/studio/marriage-certificate.png" alt-text="Screenshot that shows a sample marriage certificate." lightbox="./media/studio/marriage-certificate.png":::
333333

334334
> [!div class="nextstepaction"]
335-
> [Learn more: identity document model](concept-marriage-certificate.md)
335+
> [Learn more: Identity document model](concept-marriage-certificate.md)
336336
337337
### Credit card
338338

@@ -345,7 +345,7 @@ This sample credit card was processed by using [Document Intelligence Studio](ht
345345
:::image type="content" source="./media/studio/credit-card.png" alt-text="Screenshot that shows a sample credit card." lightbox="./media/studio/credit-card.png":::
346346

347347
> [!div class="nextstepaction"]
348-
> [Learn more: identity document model](concept-credit-card.md)
348+
> [Learn more: Identity document model](concept-credit-card.md)
349349
350350
### Custom models
351351

@@ -364,7 +364,7 @@ This sample custom template was processed by using [Document Intelligence Studio
364364
:::image type="content" source="media/studio/train-model.png" alt-text="Screenshot that shows Document Intelligence analyzing a custom form.":::
365365

366366
> [!div class="nextstepaction"]
367-
> [Learn more: custom model](train/custom-model.md)
367+
> [Learn more: Custom model](train/custom-model.md)
368368
369369
#### Custom extraction
370370

@@ -377,10 +377,10 @@ This sample custom extraction was processed by using [Document Intelligence Stud
377377
:::image type="content" source="media/studio/custom-extraction-models.png" alt-text="Screenshot that shows custom extraction model analysis in Document Intelligence Studio.":::
378378

379379
> [!div class="nextstepaction"]
380-
> [Learn more: custom template model](train/custom-template.md)
380+
> [Learn more: Custom template model](train/custom-template.md)
381381
382382
> [!div class="nextstepaction"]
383-
> [Learn more: custom neural model](./train/custom-neural.md)
383+
> [Learn more: Custom neural model](./train/custom-neural.md)
384384
385385
#### Custom classifier
386386

@@ -389,18 +389,18 @@ This sample custom extraction was processed by using [Document Intelligence Stud
389389
With the custom classification model, you can identify the document type before you invoke the extraction model. The classification model is available starting with the 2023-07-31 (GA) API. Training a custom classification model requires at least two distinct classes and a minimum of five samples per class.
390390

391391
> [!div class="nextstepaction"]
392-
> [Learn more: custom classification model](train/custom-classifier.md)
392+
> [Learn more: Custom classification model](train/custom-classifier.md)
393393
394394
#### Composed models
395395

396-
A composed model is created by taking a collection of custom models and assigning them to a single model built from your form types. You can assign multiple custom models to a composed model called with a single model ID. You can assign up to 200 trained custom models to a single composed model.
396+
A composed model is created by taking a collection of custom models and assigning them to a single model built from your form types. You can assign multiple custom models to a composed model that are called with a single model ID. You can assign up to 200 trained custom models to a single composed model.
397397

398398
This sample composed model is in [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/customform/projects).
399399

400400
:::image type="content" source="media/studio/composed-model.png" alt-text="Screenshot that shows the Document Intelligence Studio Compose custom model pane.":::
401401

402402
> [!div class="nextstepaction"]
403-
> [Learn more: custom model](train/custom-model.md)
403+
> [Learn more: Custom model](train/custom-model.md)
404404
405405
## Input requirements
406406

@@ -440,7 +440,7 @@ This sample document was processed by using the [Sample Labeling tool](https://f
440440

441441
> [!div class="nextstepaction"]
442442
>
443-
> [Learn more: layout model](prebuilt/layout.md)
443+
> [Learn more: Layout model](prebuilt/layout.md)
444444
445445
### Invoice
446446

@@ -451,7 +451,7 @@ This sample invoice was processed by using the [Sample Labeling tool](https://fo
451451
:::image type="content" source="./media/overview-invoices.jpg" alt-text="Screenshot that shows a sample invoice analysis by using the Sample Labeling tool.":::
452452

453453
> [!div class="nextstepaction"]
454-
> [Learn more: invoice model](prebuilt/invoice.md)
454+
> [Learn more: Invoice model](prebuilt/invoice.md)
455455
456456
### Receipt
457457

@@ -462,7 +462,7 @@ This sample receipt was processed by using the [Sample Labeling tool](https://fo
462462
:::image type="content" source="./media/receipts-example.jpg" alt-text="Screenshot that shows a sample receipt." lightbox="./media/overview-receipt.jpg":::
463463

464464
> [!div class="nextstepaction"]
465-
> [Learn more: receipt model](prebuilt/receipt.md)
465+
> [Learn more: Receipt model](prebuilt/receipt.md)
466466
467467
### ID document
468468

@@ -476,7 +476,7 @@ This sample US driver's license was processed by using the [Sample Labeling tool
476476
:::image type="content" source="./media/id-example-drivers-license.jpg" alt-text="Screenshot that shows a sample identification card.":::
477477

478478
> [!div class="nextstepaction"]
479-
> [Learn more: identity document model](prebuilt/id-document.md)
479+
> [Learn more: Identity document model](prebuilt/id-document.md)
480480
481481
### Business card
482482

@@ -487,7 +487,7 @@ This sample business card was processed by using the [Sample Labeling tool](http
487487
:::image type="content" source="./media/business-card-example.jpg" alt-text="Screenshot that shows a sample business card.":::
488488

489489
> [!div class="nextstepaction"]
490-
> [Learn more: business card model](concept-business-card.md)
490+
> [Learn more: Business card model](concept-business-card.md)
491491
492492
### Custom
493493

@@ -498,7 +498,7 @@ This sample custom model was processed by using the [Sample Labeling tool](https
498498
:::image type="content" source="media/overview-custom.jpg" alt-text="Screenshot that shows the Document Intelligence tool analyzing a custom form pane.":::
499499

500500
> [!div class="nextstepaction"]
501-
> [Learn more: custom model](train/custom-model.md)
501+
> [Learn more: Custom model](train/custom-model.md)
502502
503503
#### Composed custom model
504504

@@ -509,7 +509,7 @@ This composed model pane was processed by using the [Sample Labeling tool](https
509509
:::image type="content" source="media/custom-model-compose.png" alt-text="Screenshot that shows the Document Intelligence Studio Compose custom model pane.":::
510510

511511
> [!div class="nextstepaction"]
512-
> [Learn more: custom model](train/custom-model.md)
512+
> [Learn more: Custom model](train/custom-model.md)
513513
514514
## Model data extraction
515515

0 commit comments

Comments
 (0)