Skip to content

Commit 614f715

Browse files
committed
Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into manlint
2 parents 601d03e + e379683 commit 614f715

File tree

531 files changed

+5816
-4489
lines changed

Some content is hidden

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

531 files changed

+5816
-4489
lines changed

articles/ai-services/.openpublishing.redirection.ai-services.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,11 @@
115115
"redirect_url": "/azure/ai-services/translator/document-translation/reference/rest-api-guide",
116116
"redirect_document_id": false
117117
},
118+
{
119+
"source_path_from_root": "/articles/ai-services/openai/how-to/monitoring.md",
120+
"redirect_url": "/azure/ai-services/openai/how-to/monitor-openai",
121+
"redirect_document_id": false
122+
},
118123
{
119124
"source_path_from_root": "/articles/ai-services/openai/how-to/prepare-dataset.md",
120125
"redirect_url": "/azure/ai-services/openai/concepts/fine-tuning-considerations",

articles/ai-services/content-safety/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ To use the Content Safety APIs, you must create your Azure AI Content Safety res
156156
| France Central || | | || ||
157157
| West Europe |||| || ||
158158
| Japan East || | | || ||
159-
| Australia East|| | | ||||
159+
| Australia East|| | | ||||
160160
| USGov Arizona || | | | | | |
161161
| USGov Virginia || | | | | | |
162162

articles/ai-services/content-safety/quickstart-groundedness.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,9 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
6969
```Python
7070
import http.client
7171
import json
72-
73-
conn = http.client.HTTPSConnection("<endpoint>/contentsafety/text:detectGroundedness?api-version=2024-02-15-preview")
72+
73+
endpoint = "<your_custom_subdomain>.cognitiveservices.azure.com"
74+
conn = http.client.HTTPSConnection(endpoint)
7475
payload = json.dumps({
7576
"domain": "Generic",
7677
"task": "QnA",
@@ -81,7 +82,7 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
8182
"groundingSources": [
8283
"I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. IF they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
8384
],
84-
"reasoning": false
85+
"reasoning": False
8586
})
8687
headers = {
8788
'Ocp-Apim-Subscription-Key': '<your_subscription_key>',

articles/ai-services/document-intelligence/concept-custom-generative.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Field extraction custom generative model `2024-07-31-preview` version is only av
9090

9191
* **Field Description**. Provide more contextual information in description to help clarify the field that needs to be extracted. Examples include location in the document, potential field labels it can be associated with, and ways to differentiate with other terms that could be ambiguous.
9292

93-
* **Variation**. Custom generative models can generalize across different document templates of the same document type. As a best practice, create a single model for all variations of a document type. Ideally, include a visual template for each type, especially for ones that
93+
* **Variation**. Custom generative models can generalize across different document templates of the same document type. As a best practice, create a single model for all variations of a document type. Ideally, include a visual template for each type, especially for ones that involve distinct formatting or structural elements, to improve the model's accuracy and consistency in generating or processing documents.
9494

9595
## Service guidance
9696

articles/ai-services/document-intelligence/concept-mortgage-documents.md

Lines changed: 4 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The Document Intelligence Mortgage models use powerful Optical Character Recogni
2626
**Supported document types:**
2727

2828
* Uniform Residential Loan Application (Form 1003)
29+
* Uniform Residential Appraisal Report (Form 1004)
30+
* Verification of employment form (Form 1005)
2931
* Uniform Underwriting and Transmittal Summary (Form 1008)
3032
* Closing Disclosure form
3133

@@ -38,7 +40,7 @@ Document Intelligence v4.0 (2024-07-31-preview) supports the following tools, ap
3840

3941
| Feature | Resources | Model ID |
4042
|----------|-------------|-----------|
41-
|**Mortgage model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-07-31-preview)&preserve-view=true)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**&bullet; prebuilt-mortgage.us.1003</br>&bullet; prebuilt-mortgage.us.1008</br>&bullet; prebuilt-mortgage.us.closingDisclosure**|
43+
|**Mortgage model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-07-31-preview)&preserve-view=true)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**&bullet; prebuilt-mortgage.us.1003</br>&bullet; prebuilt-mortgage.us.1004</br>&bullet; prebuilt-mortgage.us.1005</br>&bullet; prebuilt-mortgage.us.1008</br>&bullet; prebuilt-mortgage.us.closingDisclosure**|
4244
::: moniker-end
4345

4446
## Input requirements
@@ -126,74 +128,6 @@ The following are the fields extracted from a 1003 URLA form in the JSON output
126128
|`Property.MixedUseProperty`|`selectionGroup`|Is the property a mixed-use property?|:selected: NO:unselected: YES|
127129
|`Property.ManufacturedHome`|`selectionGroup`|Is the property a manufactured home?|:selected: NO:unselected: YES|
128130

129-
## [2024-02-29-preview](#tab/2024-02-29-preview)
130-
131-
132-
### Supported languages and locales
133-
134-
135-
136-
| Supported Languages | Details |
137-
|:--------------------|:-------:|
138-
|English|United States (`en-US`)|
139-
140-
141-
### Supported document fields
142-
143-
#### mortgage.us.1003
144-
145-
| Field | Type | Description | Example |
146-
|:------|:-----|:------------|:--------|
147-
|`LenderLoanNumber`|`string`|Lender loan number or universal loan identifier|10Bx939c5543TqA1144M999143X38|
148-
|`AgencyCaseNumber`|`string`|Agency case number|115894|
149-
|`Borrower`|`object`|||
150-
|`Borrower.Name`|`string`|Borrower's full name as written on the form|Gwen Stacy|
151-
|`Borrower.SocialSecurityNumber`|`string`|Borrower's social security number|557-99-7283|
152-
|`Borrower.BirthDate`|`date`|Borrower's date of birth|11/07/1989|
153-
|`Borrower.CitizenshipType`|`selectionGroup`|Borrower's citizenship|:selected: U.S. Citizen<br>:unselected: Permanent Resident Alien<br>:unselected: Non-Permanent Resident Alien|
154-
|`Borrower.CreditApplicationType`|`selectionGroup`|Borrower's credit type|:selected: I'm applying for individual credit.<br>:unselected: I'm applying for joint credit.|
155-
|`Borrower.NumberOfBorrowers`|`integer`|Total number of borrowers|1|
156-
|`Borrower.MaritalStatus`|`selectionGroup`|Borrower's marital status|:selected: Married<br>:unselected: Separated<br>:unselected: Unmarried|
157-
|`Borrower.NumberOfDependents`|`integer`|Total number of borrower's dependents|2|
158-
|`Borrower.DependentsAges`|`string`|Age of borrower's dependents|10, 11|
159-
|`Borrower.HomePhoneNumber`|`phoneNumber`|Borrower's home phone number|(818) 246-8900|
160-
|`Borrower.CellPhoneNumber`|`phoneNumber`|Borrower's cell phone number|(831) 728-4766|
161-
|`Borrower.WorkPhoneNumber`|`phoneNumber`|Borrower's work phone number|(987) 213-5674|
162-
|`Borrower.CurrentAddress`|`address`|Borrower's current address|1634 W Glenoaks Blvd<br>Glendale CA 91201 United States|
163-
|`Borrower.YearsInCurrentAddress`|`integer`|Years in current address|1|
164-
|`Borrower.MonthsInCurrentAddress`|`integer`|Months in current address|1|
165-
|`Borrower.CurrentHousingExpenseType`|`selectionGroup`|Borrower's housing expense type|:unselected: No primary housing expense:selected: Own:unselected: Rent|
166-
|`Borrower.CurrentMonthlyRent`|`number`|Borrower's monthly rent|1,600.00|
167-
|`Borrower.SignedDate`|`date`|Borrower's signature date|03/16/2021|
168-
|`CoBorrower`|`object`|||
169-
|`CoBorrower.Names`|`string`|Coborrowers' names|Peter Parker<br>Mary Jane Watson|
170-
|`CoBorrower.SignedDate`|`date`|Coborrower's signature date|03/16/2021|
171-
|`CurrentEmployment`|`object`|||
172-
|`CurrentEmployment.DoesNotApply`|`boolean`|Checkbox state of 'Doesn't apply'|:selected:|
173-
|`CurrentEmployment.EmployerName`|`string`|Borrower's employer or business name|Spider Wb Corp.|
174-
|`CurrentEmployment.EmployerPhoneNumber`|`phoneNumber`|Borrower's employer phone number|(390) 353-2474|
175-
|`CurrentEmployment.EmployerAddress`|`address`|Borrower's employer address|3533 Band Ave<br>Glendale CA 92506 United States|
176-
|`CurrentEmployment.PositionOrTitle`|`string`|Borrower's position or title|Language Teacher|
177-
|`CurrentEmployment.StartDate`|`date`|Borrower's employment start date|01/08/2020|
178-
|`CurrentEmployment.GrossMonthlyIncomeTotal`|`number`|Borrower's gross monthly income total|4,254.00|
179-
|`Loan`|`object`|||
180-
|`Loan.Amount`|`number`|Loan amount|156,000.00|
181-
|`Loan.PurposeType`|`selectionGroup`|Loan purpose type|:unselected: Purchase:selected: Refinance:unselected: Other|
182-
|`Loan.OtherPurpose`|`string`|Other loan purpose type|Construction|
183-
|`Loan.RefinanceType`|`selectionGroup`|Loan refinance type|:selected: No Cash Out<br>:unselected: Limited Cash Out<br>:unselected: Cash Out|
184-
|`Loan.RefinanceProgramType`|`selectionGroup`|Loan refinance program type|:unselected: Full Documentation:selected: Interest Rate Reduction<br>:unselected: Streamlined without Appraisal<br>:unselected: Other|
185-
|`Loan.OtherRefinanceProgram`|`string`|Other loan refinance program type|Cash-out refinance|
186-
|`Property`|`object`|||
187-
|`Property.Address`|`address`|Property address|1634 W Glenoaks Blvd<br>Glendale CA 91201 Los Angeles|
188-
|`Property.NumberOfUnits`|`integer`|Number of units|1|
189-
|`Property.Value`|`number`|Property value|200,000.00|
190-
|`Property.OccupancyStatus`|`selectionGroup`|Property occupancy status|:selected: Primary Residence<br>:unselected: Second Home<br>:unselected: Investment Property|
191-
|`Property.IsFhaSecondaryResidence`|`boolean`|Checkbox state of '`FHA` Secondary Residence'|:unselected:|
192-
|`Property.MixedUseProperty`|`selectionGroup`|Is the property a mixed-use property?|:selected: NO:unselected: YES|
193-
|`Property.ManufacturedHome`|`selectionGroup`|Is the property a manufactured home?|:selected: NO:unselected: YES|
194-
195-
196-
The 1003 URLA key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
197131

198132
## Field extraction 1004 Uniform Residential Appraisal Report (URAR)
199133
The following are the fields extracted from a 1004 URAR form in the JSON output response.
@@ -404,4 +338,4 @@ The mortgage closing disclosure key-value pairs and line items extracted are in
404338
* Try processing your own forms and documents with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio).
405339

406340
* Complete a [Document Intelligence quickstart](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.
407-
341+

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

Lines changed: 48 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ metadata:
77
title: Document Intelligence documentation - Quickstarts, Tutorials, API Reference - Azure AI services | Microsoft Docs
88
description: Azure AI Document Intelligence is a cloud-based Azure AI service that uses machine-learning models to extract key-value pairs, text, and tables from your documents. Document Intelligence analyzes your forms and documents, extracts text and data, maps field relationships as key-value pairs, and returns a structured JSON output. You quickly get accurate results that are tailored to your specific content without excessive manual intervention or extensive data science expertise. Use Document Intelligence to automate your data processing in applications and workflows, enhance data-driven strategies, and enrich document search capabilities.
99
ms.service: azure-ai-document-intelligence
10-
ms.custom:
11-
- ignite-2023
1210
ms.topic: landing-page
1311
author: laujan
1412
ms.author: lajanuar
15-
ms.date: 01/31/2024
13+
ms.date: 08/21/2024
1614
monikerRange: '<=doc-intel-4.0.0'
1715
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
1816
# Limits: https://learn.learn.microsoft.com/help/contribute/contribute-how-to-write-landing-page?branch=main#limits
@@ -33,79 +31,74 @@ landingContent:
3331
links:
3432
- text: What's new in Azure AI Document Intelligence?
3533
url: whats-new.md
36-
- linkListType: reference
37-
links:
38-
- text: 🆕 SDK overview `2024-02-29-preview` (v4.0 preview)
39-
url: sdk-overview-v4-0.md
40-
- text: SDK overview `2023-07-31` latest (v3.1 GA)
41-
url: sdk-overview-v3-1.md
42-
- text: SDK overview `2022-08-31` legacy (v3.0 GA)
43-
url: sdk-overview-v3-0.md
44-
45-
#Card 2
46-
- title: Document Intelligence Studio
47-
linkLists:
48-
- linkListType: overview
49-
links:
50-
- text: Studio overview
51-
url: studio-overview.md
52-
- text: Studio concepts
53-
url: concept-document-intelligence-studio.md
5434

55-
#Card 3
35+
#Card 2
5636
- title: Document Intelligence models
5737
linkLists:
58-
- linkListType: architecture
38+
- linkListType: learn
5939
links:
6040
- text: Read
6141
url: concept-read.md
6242
- text: Layout
6343
url: concept-layout.md
64-
- text: Invoice
65-
url: concept-invoice.md
66-
- text: Receipt
67-
url: concept-receipt.md
68-
- text: ID document
69-
url: concept-id-document.md
70-
- text: Health insurance card
71-
url: concept-health-insurance-card.md
72-
- text: Contract
73-
url: concept-contract.md
74-
- text: US tax documents
75-
url: concept-tax-document.md
44+
- text: Financial Services and Legal
45+
url: overview.md#financial-services-and-legal
46+
- text: US Tax
47+
url: overview.md#us-tax
48+
- text: Personal identification
49+
url: overview.md#personal-identification
50+
- text: Custom field extraction
51+
url: overview.md#document-field-extraction-models
52+
- text: Custom classification
53+
url: overview.md#custom-classification-models
54+
- text: Add-on capabilities
55+
url: concept-add-on-capabilities.md
56+
- text: Query field extraction
57+
url: concept-query-fields.md
7658

59+
#Card 3
60+
- title: Document Intelligence Studio
61+
linkLists:
62+
- linkListType: overview
63+
links:
64+
- text: Studio overview
65+
url: studio-overview.md
66+
- text: Studio concepts
67+
url: concept-document-intelligence-studio.md
7768
#Card 4
7869
- title: Document Intelligence concepts
7970
linkLists:
8071
- linkListType: concept
8172
links:
82-
- text: 🆕 Query field extraction
83-
url: concept-query-fields.md
84-
- text: 🆕 Add-on capabilities
85-
url: concept-add-on-capabilities.md
86-
- text: 🆕 Retrieve-Augmented Generation (RAG)
73+
- text: 🆕 Custom generative model
74+
url: concept-custom-generative.md
75+
- text: 🆕 Retrieval-Augmented Generation (RAG)
8776
url: concept-retrieval-augmented-generation.md
88-
- linkListType: concept
89-
links:
90-
- text: Pretrained model overview
91-
url: concept-model-overview.md
77+
- text: 🆕 Batch document analysis
78+
url: concept-batch-analysis.md
9279
- text: Accuracy and confidence scores
9380
url: concept-accuracy-confidence.md
94-
- text: "API response: analyze document"
81+
- text: Use the analyzeDocument response
9582
url: concept-analyze-document-response.md
9683
- text: Custom model overview
9784
url: concept-custom.md
98-
99-
100-
#Card 5
101-
- title: Quickstarts and how-to-guides
85+
# Card 5
86+
- title: Responsible AI
10287
linkLists:
103-
- linkListType: quickstart
88+
- linkListType: reference
10489
links:
105-
- text: Document Intelligence Studio
106-
url: quickstarts/try-document-intelligence-studio.md
107-
- text: Document Intelligence SDK
108-
url: quickstarts/get-started-sdks-rest-api.md
90+
- text: Transparency notes
91+
url: /legal/cognitive-services/document-intelligence/transparency-note?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
92+
- text: Characteristics and limitations
93+
url: /legal/cognitive-services/document-intelligence/characteristics-and-limitations?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
94+
- text: Guidance for integration and responsible use
95+
url: /legal/cognitive-services/document-intelligence/guidance-integration-responsible-use?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
96+
- text: Data privacy, compliance, and security
97+
url: /legal/cognitive-services/document-intelligence/data-privacy-security?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json#Card 5
98+
99+
# Card 6
100+
- title: How-to-guides
101+
linkLists:
109102
- linkListType: how-to-guide
110103
links:
111104
- text: Create a Document Intelligence resource
@@ -123,16 +116,4 @@ landingContent:
123116
- text: Install and run Document Intelligence containers
124117
url: containers/install-run.md
125118

126-
# Card 6
127-
- title: Responsible AI
128-
linkLists:
129-
- linkListType: reference
130-
links:
131-
- text: Transparency notes
132-
url: /legal/cognitive-services/document-intelligence/transparency-note?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
133-
- text: Characteristics and limitations
134-
url: /legal/cognitive-services/document-intelligence/characteristics-and-limitations?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
135-
- text: Guidance for integration and responsible use
136-
url: /legal/cognitive-services/document-intelligence/guidance-integration-responsible-use?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
137-
- text: Data privacy, compliance, and security
138-
url: /legal/cognitive-services/document-intelligence/data-privacy-security?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
119+

0 commit comments

Comments
 (0)