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-services/document-intelligence/concept-mortgage-documents.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: laujan
6
6
manager: nitinme
7
7
ms.service: azure-ai-document-intelligence
8
8
ms.topic: conceptual
9
-
ms.date: 04/24/2024
9
+
ms.date: 05/07/2024
10
10
ms.author: lajanuar
11
11
monikerRange: '>=doc-intel-4.0.0'
12
12
---
@@ -25,9 +25,9 @@ The Document Intelligence Mortgage models use powerful Optical Character Recogni
25
25
26
26
**Supported document types:**
27
27
28
-
*1003 End-User License Agreement (EULA)
29
-
* Form 1008
30
-
*Mortgage closing disclosure
28
+
*Uniform Residential Loan Application (Form 1003)
29
+
*Uniform Underwriting and Transmittal Summary (Form 1008)
30
+
*Closing Disclosure form
31
31
32
32
33
33
## Development options
@@ -72,9 +72,9 @@ To see how data extraction works for the mortgage documents service, you need th
72
72
73
73
*See* our [Language Support—prebuilt models](language-support-prebuilt.md) page for a complete list of supported languages.
74
74
75
-
## Field extraction 1003 EULA
75
+
## Field extraction 1003 Uniform Residential Loan Application (URLA)
76
76
77
-
The following are the fields extracted from a 1003 end-user license agreement (EULA) form in the JSON output response.
77
+
The following are the fields extracted from a 1003 URLA form in the JSON output response.
78
78
79
79
|Name| Type | Description | Example output |
80
80
|:-----|:----|:----|:---:|
@@ -86,9 +86,9 @@ The following are the fields extracted from a 1003 end-user license agreement (E
86
86
| Loan| Object | An object that contains loan information including: amount, purpose type, refinance type.||
87
87
| Property | object | An object that contains information about the property including: address, number of units, value.||
88
88
89
-
The 1003 EULA key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
89
+
The 1003 URLA key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
90
90
91
-
## Field extraction tax form 1008
91
+
## Field extraction 1008 Uniform Underwriting and Transmittal Summary
92
92
93
93
The following are the fields extracted from a 1008 form in the JSON output response.
94
94
@@ -112,7 +112,6 @@ The following are the fields extracted from a mortgage closing disclosure form i
112
112
| Transaction | Object | An object that contains information about the transaction information including: Borrowers name, Borrowers address, Seller name.||
113
113
| Loan | Object | An object that contains loan information including: term, purpose, product. ||
114
114
115
-
116
115
The mortgage closing disclosure key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
@@ -318,7 +318,6 @@ You can use Document Intelligence to automate document processing in application
318
318
> [Return to model types](#document-analysis-models)
319
319
320
320
:::moniker-end
321
-
322
321
### Invoice
323
322
324
323
:::image type="content" source="media/overview/analyze-invoice.png" alt-text="Screenshot of Invoice model analysis using Document Intelligence Studio.":::
@@ -358,7 +357,7 @@ You can use Document Intelligence to automate document processing in application
358
357
359
358
| Model ID | Description |Automation use cases | Development options |
|[**prebuilt-mortgage.us.1003**](concept-mortgage-documents.md)|● Extract key information from 1003 loan applications. </br>● [Data and field extraction](concept-mortgage-documents.md#field-extraction-1003-eula)|● Fannie Mae and Freddie Mac documentation requirements.| ● [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=mortgage.us.1003&formType=mortgage.us.1003)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
360
+
|[**prebuilt-mortgage.us.1003**](concept-mortgage-documents.md)|● Extract key information from `1003` loan applications. </br>● [Data and field extraction](concept-mortgage-documents.md#field-extraction-1003-uniform-residential-loan-application-urla)|● Fannie Mae and Freddie Mac documentation requirements.| ● [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=mortgage.us.1003&formType=mortgage.us.1003)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
362
361
363
362
> [!div class="nextstepaction"]
364
363
> [Return to model types](#prebuilt-models)
@@ -369,7 +368,7 @@ You can use Document Intelligence to automate document processing in application
369
368
370
369
| Model ID | Description |Automation use cases | Development options |
|[**prebuilt-mortgage.us.1008**](concept-mortgage-documents.md)|● Extract key information from Uniform Underwriting and Transmittal Summary. </br>● [Data and field extraction](concept-mortgage-documents.md#field-extraction-tax-form-1008)|● Loan underwriting processing using summary data.| ● [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=mortgage.us.1008&formType=mortgage.us.1008)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
371
+
|[**prebuilt-mortgage.us.1008**](concept-mortgage-documents.md)|● Extract key information from Uniform Underwriting and Transmittal Summary. </br>● [Data and field extraction](concept-mortgage-documents.md#field-extraction-1008-uniform-underwriting-and-transmittal-summary)|● Loan underwriting processing using summary data.| ● [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=mortgage.us.1008&formType=mortgage.us.1008)</br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
373
372
374
373
> [!div class="nextstepaction"]
375
374
> [Return to model types](#prebuilt-models)
@@ -454,7 +453,7 @@ You can use Document Intelligence to automate document processing in application
454
453
455
454
| Model ID | Description |Development options |
456
455
|----------|--------------|-------------------|
457
-
|[**prebuilt-tax.us.1098E**](concept-tax-document.md)|Extract student loan information and details. </br>●[Data and field extraction](concept-tax-document.md#field-extraction-1098)|●[**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1098&formType=tax.us.1098E)</br>●[**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>●[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
456
+
|[**prebuilt-tax.us.1098E**](concept-tax-document.md)|Extract student loan information and details. </br>● [Data and field extraction](concept-tax-document.md#field-extraction-1098)|● [**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1098&formType=tax.us.1098E)</br>● </br>● [**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>● [**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
458
457
459
458
> [!div class="nextstepaction"]
460
459
> [Return to model types](#prebuilt-models)
@@ -476,7 +475,7 @@ You can use Document Intelligence to automate document processing in application
476
475
477
476
| Model ID |Description|Development options |
478
477
|----------|--------------|-----------------|
479
-
|[**prebuilt-tax.us.1099{`variation`}**](concept-tax-document.md)|Extract information from 1099-form variations.</br>●[Data and field extraction](concept-tax-document.md#field-extraction-1099-nec)|●[**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1099)</br>●[**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>●[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
478
+
|[**prebuilt-tax.us.1099{`variation`}**](concept-tax-document.md)|Extract information from 1099-form variations.|●</br>●[Data and field extraction](concept-tax-document.md#field-extraction-1099-nec)[**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1099)</br>●[**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>●[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
480
479
481
480
> [!div class="nextstepaction"]
482
481
> [Return to model types](#prebuilt-models)
@@ -487,7 +486,7 @@ You can use Document Intelligence to automate document processing in application
487
486
488
487
| Model ID |Description|Development options |
489
488
|----------|--------------|-----------------|
490
-
|**prebuilt-tax.us.1040**|Extract information from 1040-form variations.</br>●[Data and field extraction](concept-tax-document.md#field-extraction-1040-tax-form)|●[**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1040)</br>●[**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>●[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
489
+
|**prebuilt-tax.us.1040**|Extract information from 1040-form variations.|●</br>●[Data and field extraction](concept-tax-document.md#field-extraction-1040-tax-form)[**Document Intelligence Studio**](https://documentintelligence.ai.azure.com/studio/prebuilt?formCategory=tax.us.1040)</br>●[**REST API**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true&pivots=programming-language-rest-api#analyze-document-post-request)</br>●[**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)</br>●[**JavaScript**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true#prebuilt-model)|
491
490
492
491
::: moniker range="<=doc-intel-3.1.0"
493
492
@@ -539,7 +538,7 @@ You can use Document Intelligence to automate document processing in application
539
538
540
539
| About | Description |Automation use cases | Development options |
|[**Custom Neural model**](concept-custom-neural.md)| The custom neural model is used to extract labeled data from structured (surveys, questionnaires), semi-structured (invoices, purchase orders), and unstructured documents (contracts, letters).|Extract text data, checkboxes, and tabular fields from structured and unstructured documents.|● [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>● [**REST API**](/rest/api/aiservices/document-models/build-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|
541
+
|[**Custom Neural model**](concept-custom-neural.md)| The custom neural model is used to extract labeled data from structured (surveys, questionnaires), semi-structured (invoices, purchase orders), and unstructured documents (contracts, letters).|Extract text data, checkboxes, and tabular fields from structured and unstructured documents.|[**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>● [**REST API**](/rest/api/aiservices/document-models/build-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br>● [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>● [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|
Copy file name to clipboardExpand all lines: articles/ai-services/language-service/conversational-language-understanding/concepts/best-practices.md
+35Lines changed: 35 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -216,3 +216,38 @@ curl --request POST \
216
216
"targetResourceRegion": "<target-region>"
217
217
}'
218
218
```
219
+
220
+
221
+
## Addressing out of domain utterances
222
+
223
+
Customers can use the new recipe version '2024-06-01-preview' in case the model has poor AIQ on out of domain utterances. An example of this with the default recipe can be like the below where the model has 3 intents Sports, QueryWeather and Alarm. The test utterances are out of domain utterances and the model classifies them as InDomain with a relatively high confidence score.
224
+
225
+
| Text | Predicted intent | Confidence score |
226
+
|----|----|----|
227
+
| "*Who built the Eiffel Tower?*" |`Sports`| 0.90 |
228
+
| "*Do I look good to you today?*" |`QueryWeather`| 1.00 |
229
+
| "*I hope you have a good evening.*" |`Alarm`| 0.80 |
230
+
231
+
To address this, use the `2024-06-01-preview` configuration version that is built specifically to address this issue while also maintaining reasonably good quality on In Domain utterances.
Once the request is sent, you can track the progress of the training job in Language Studio as usual.
250
+
251
+
Caveats:
252
+
- The None Score threshold for the app (confidence threshold below which the topIntent is marked as None) when using this recipe should be set to 0. This is because this new recipe attributes a certain portion of the in domain probabiliities to out of domain so that the model is not incorrectly overconfident about in domain utterances. As a result, users may see slightly reduced confidence scores for in domain utterances as compared to the prod recipe.
253
+
- This recipe is not recommended for apps with just two (2) intents, such as IntentA and None, for example.
0 commit comments