Skip to content

Commit 03fd015

Browse files
authored
Merge pull request #276231 from laujan/242353-apim-links-to-rest-reference
apim links to rest reference
2 parents d4a5ebb + 6dd03a5 commit 03fd015

Some content is hidden

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

62 files changed

+163
-165
lines changed

articles/ai-services/document-intelligence/concept-add-on-capabilities.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 05/06/2024
11+
ms.date: 05/23/2024
1212
ms.author: lajanuar
1313
monikerRange: '>=doc-intel-3.1.0'
1414
---
@@ -70,7 +70,7 @@ The following add-on capabilities are available for`2024-02-29-preview`, `2024-0
7070

7171
## Version availability
7272

73-
|Add-on Capability| Add-On/Free|[2024-02-29-preview](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&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)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)|[v2.1 (GA)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)|
73+
|Add-on Capability| Add-On/Free|[2024-02-29-preview](/rest/api/aiservices/operation-groups?view=rest-aiservices-2024-02-29-preview&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)|
7474
|----------------|-----------|---|--|---|---|
7575
|Font property extraction|Add-On| ✔️| ✔️| n/a| n/a|
7676
|Formula extraction|Add-On| ✔️| ✔️| n/a| n/a|

articles/ai-services/document-intelligence/concept-business-card.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 05/23/2024
1212
ms.author: lajanuar
1313
---
1414

@@ -37,11 +37,11 @@ ms.author: lajanuar
3737

3838
::: moniker range=">=doc-intel-3.0.0"
3939

40-
The Document Intelligence business card model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract data from business card images. The API analyzes printed business cards; extracts key information such as first name, last name, company name, email address, and phone number; and returns a structured JSON data representation.
40+
The Document Intelligence business card model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract data from business card images. The API analyzes printed business cards; extracts key information such as first name, surname, company name, email address, and phone number; and returns a structured JSON data representation.
4141

4242
## Business card data extraction
4343

44-
Business cards are a great way to represent a business or a professional. The company logo, fonts and background images found in business cards help promote the company branding and differentiate it from others. Applying OCR and machine-learning based techniques to automate scanning of business cards is a common image processing scenario. Enterprise systems used by sales and marketing teams typically have business card data extraction capability integration into for the benefit of their users.
44+
Business cards are a great way to represent a business or a professional. The company logo, fonts, and background images found in business cards help promote the company branding and differentiate it from others. Applying OCR and machine-learning based techniques to automate scanning of business cards is a common image processing scenario. Enterprise systems used by sales and marketing teams typically have business card data extraction capability integration into for the benefit of their users.
4545

4646
***Sample business card processed with [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)***
4747

@@ -74,7 +74,7 @@ Document Intelligence **v3.0:2022-08-31 (GA)** supports the following tools, app
7474

7575
| Feature | Resources | Model ID |
7676
|----------|-------------|-----------|
77-
|**Business card model**| &bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)<br>&bullet; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)<br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-businessCard**|
77+
|**Business card model**| &bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/prebuilt?formType=businessCard)<br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)<br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)<br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-businessCard**|
7878

7979
::: moniker-end
8080

@@ -149,7 +149,7 @@ See how data, including name, job title, address, email, and company name, is ex
149149

150150
1. Select **Run analysis**. The Document Intelligence Sample Labeling tool calls the Analyze Prebuilt API and analyze the document.
151151

152-
1. View the results - see the key-value pairs extracted, line items, highlighted text extracted and tables detected.
152+
1. View the results - see the key-value pairs extracted, line items, highlighted text extracted, and tables detected.
153153

154154
:::image type="content" source="media/business-card-results.png" alt-text="Screenshot of the business card model analyze results operation.":::
155155

@@ -168,8 +168,8 @@ See how data, including name, job title, address, email, and company name, is ex
168168

169169
::: moniker range="doc-intel-2.1.0"
170170

171-
* Supported file formats: JPEG, PNG, PDF, and TIFF
172-
* For PDF and TIFF, up to 2000 pages are processed. For free tier subscribers, only the first two pages are processed.
171+
* The supported file formats: JPEG, PNG, PDF, and TIFF
172+
* PDF and TIFF, up to 2,000 pages are processed. For free tier subscribers, only the first two pages are processed.
173173
* The file size must be less than 50 MB and dimensions at least 50 x 50 pixels and at most 10,000 x 10,000 pixels.
174174

175175
::: moniker-end
@@ -187,16 +187,16 @@ See how data, including name, job title, address, email, and company name, is ex
187187
| ContactNames | Array of objects | Contact name | |
188188
| FirstName | String | First (given) name of contact | |
189189
| LastName | String | Last (family) name of contact | |
190-
| CompanyNames | Array of strings | Company name(s)| |
191-
| Departments | Array of strings | Department(s) or organization(s) of contact | |
192-
| JobTitles | Array of strings | Listed Job title(s) of contact | |
193-
| Emails | Array of strings | Contact email address(es) | |
194-
| Websites | Array of strings | Company website(s) | |
195-
| Addresses | Array of strings | Address(es) extracted from business card | |
196-
| MobilePhones | Array of phone numbers | Mobile phone number(s) from business card |+1 xxx xxx xxxx |
197-
| Faxes | Array of phone numbers | Fax phone number(s) from business card | +1 xxx xxx xxxx |
198-
| WorkPhones | Array of phone numbers | Work phone number(s) from business card | +1 xxx xxx xxxx |
199-
| OtherPhones | Array of phone numbers | Other phone number(s) from business card | +1 xxx xxx xxxx |
190+
| CompanyNames | Array of strings | Company name| |
191+
| Departments | Array of strings | Department or organization of contact | |
192+
| JobTitles | Array of strings | Listed Job title of contact | |
193+
| Emails | Array of strings | Contact email address | |
194+
| Websites | Array of strings | Company website | |
195+
| Addresses | Array of strings | Address extracted from business card | |
196+
| MobilePhones | Array of phone numbers | Mobile phone number from business card |+1 xxx xxx xxxx |
197+
| Faxes | Array of phone numbers | Fax phone number from business card | +1 xxx xxx xxxx |
198+
| WorkPhones | Array of phone numbers | Work phone number from business card | +1 xxx xxx xxxx |
199+
| OtherPhones | Array of phone numbers | Other phone number from business card | +1 xxx xxx xxxx |
200200

201201
::: moniker-end
202202

@@ -214,7 +214,7 @@ See how data, including name, job title, address, email, and company name, is ex
214214
| JobTitles | array of strings | Listed Job title of contact | ["Software Engineer"] |
215215
| Emails | array of strings | Contact email extracted from business card | ["[email protected]"] |
216216
| Websites | array of strings | Website extracted from business card | ["https://www.contoso.com"] |
217-
| Addresses | array of strings | Address extracted from business card | ["123 Main Street, Redmond, WA 98052"] |
217+
| Addresses | array of strings | Address extracted from business card | ["123 Main Street, Redmond, Washington 98052"] |
218218
| MobilePhones | array of phone numbers | Mobile phone number extracted from business card | ["+19876543210"] |
219219
| Faxes | array of phone numbers | Fax phone number extracted from business card | ["+19876543211"] |
220220
| WorkPhones | array of phone numbers | Work phone number extracted from business card | ["+19876543231"] |

articles/ai-services/document-intelligence/concept-composed-models.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 01/19/2024
11+
ms.date: 05/23/2024
1212
ms.author: lajanuar
1313
---
1414

@@ -104,8 +104,8 @@ Document Intelligence **v3.0:2022-08-31 (GA)** supports the following tools, app
104104

105105
| Feature | Resources |
106106
|----------|-------------|
107-
|_**Custom model**_| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br>&bullet; [C# SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [Java SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [JavaScript SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [Python SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|
108-
| _**Composed model**_| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/ComposeDocumentModel)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</br>&bullet; [JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
107+
|_**Custom model**_| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)</br>&bullet; [C# SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [Java SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [JavaScript SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [Python SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|
108+
| _**Composed model**_| &bullet; [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects)</br>&bullet; [REST API](/rest/api/aiservices/document-models/compose-model?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.formtrainingclient.startcreatecomposedmodel)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.training.formtrainingclient.begincreatecomposedmodel)</br>&bullet; [JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-begincomposemodel&preserve-view=true)</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
109109
::: moniker-end
110110

111111
::: moniker range="doc-intel-2.1.0"
@@ -115,7 +115,7 @@ Document Intelligence v2.1 supports the following resources:
115115
| Feature | Resources |
116116
|----------|-------------------------|
117117
|_**Custom model**_| &bullet; [Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net)</br>&bullet; [REST API](how-to-guides/compose-custom-models.md?view=doc-intel-2.1.0&tabs=rest&preserve-view=true)</br>&bullet; [Client library SDK](~/articles/ai-services/document-intelligence/how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true)</br>&bullet; [Document Intelligence Docker container](containers/install-run.md?tabs=custom#run-the-container-with-the-docker-compose-up-command)|
118-
| _**Composed model**_ |&bullet; [Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net/)</br>&bullet; [REST API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/Compose)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.createcomposedmodeloperation?view=azure-dotnet&preserve-view=true)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.models.createcomposedmodeloptions?view=azure-java-stable&preserve-view=true)</br>&bullet; JavaScript SDK</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
118+
| _**Composed model**_ |&bullet; [Document Intelligence labeling tool](https://fott-2-1.azurewebsites.net/)</br>&bullet; [REST API](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)</br>&bullet; [C# SDK](/dotnet/api/azure.ai.formrecognizer.training.createcomposedmodeloperation?view=azure-dotnet&preserve-view=true)</br>&bullet; [Java SDK](/java/api/com.azure.ai.formrecognizer.models.createcomposedmodeloptions?view=azure-java-stable&preserve-view=true)</br>&bullet; JavaScript SDK</br>&bullet; [Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.formtrainingclient?view=azure-python#azure-ai-formrecognizer-formtrainingclient-begin-create-composed-model&preserve-view=true)|
119119
::: moniker-end
120120

121121
## Next steps

articles/ai-services/document-intelligence/concept-contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 03/06/2024
11+
ms.date: 05/23/2024
1212
ms.author: lajanuar
1313
monikerRange: '>=doc-intel-3.0.0'
1414
---
@@ -59,7 +59,7 @@ Document Intelligence v3.0 supports the following tools, applications, and libra
5959

6060
| Feature | Resources | Model ID |
6161
|----------|-------------|-----------|
62-
|**Contract model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-contract**|
62+
|**Contract model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true)|**prebuilt-contract**|
6363
::: moniker-end
6464

6565
## Input requirements

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 02/29/2024
9+
ms.date: 05/23/2024
1010
ms.author: lajanuar
1111
ms.custom:
1212
- references_regions
@@ -155,7 +155,7 @@ As of October 18, 2022, Document Intelligence custom neural model training will
155155
> [!TIP]
156156
> You can [copy a model](disaster-recovery.md#copy-api-overview) trained in one of the select regions listed to **any other region** and use it accordingly.
157157
>
158-
> Use the [**REST API**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/CopyDocumentModelTo) or [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects) to copy a model to another region.
158+
> Use the [**REST API**](/rest/api/aiservices/document-models/copy-model-to?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP) or [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects) to copy a model to another region.
159159
160160
:::moniker-end
161161

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
88
ms.custom:
99
- ignite-2023
1010
ms.topic: conceptual
11-
ms.date: 11/21/2023
11+
ms.date: 05/23/2024
1212
ms.author: lajanuar
1313
monikerRange: 'doc-intel-4.0.0 || <=doc-intel-3.1.0'
1414
---
@@ -162,11 +162,11 @@ https://{endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31
162162

163163
::: moniker range="doc-intel-2.1.0"
164164

165-
Custom (template) models are generally available with the [v2.1 API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm).
165+
Custom (template) models are generally available with the [v2.1 API](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true).
166166

167167
| Model | REST API | SDK | Label and Test Models|
168168
|--|--|--|--|
169-
| Custom model (template) | [Document Intelligence 2.1 ](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeWithCustomForm)| [Document Intelligence SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-2.1.0&preserve-view=true?pivots=programming-language-python)| [Document Intelligence Sample labeling tool](https://fott-2-1.azurewebsites.net/)|
169+
| Custom model (template) | [Document Intelligence 2.1 ](/rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true)| [Document Intelligence SDK](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-2.1.0&preserve-view=true?pivots=programming-language-python)| [Document Intelligence Sample labeling tool](https://fott-2-1.azurewebsites.net/)|
170170

171171
::: moniker-end
172172

0 commit comments

Comments
 (0)