Skip to content

Commit 073acba

Browse files
Merge pull request #210447 from laujan/1985513-fr-sdk-sept-release
ga sdk september 2022 release
2 parents 7ad934a + 3cde5dc commit 073acba

File tree

16 files changed

+717
-566
lines changed

16 files changed

+717
-566
lines changed

articles/applied-ai-services/form-recognizer/compose-custom-models-v3.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -214,32 +214,32 @@ You can use the programming language of your choice to create a composed model:
214214

215215
| Programming language| Code sample |
216216
|--|--|
217-
|**C#** | [Model compose](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_ModelCompose.md#create-a-composed-model)
218-
|**Java** | [Model compose](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_ModelCompose.md#create-a-composed-model)
219-
|**JavaScript** | [Compose model](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/samples/v4-beta/javascript/composeModel.js)
220-
|**Python** | [Create composed model](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0b3/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_create_composed_model.py)
217+
|**C#** | [Model compose](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.FormRecognizer_4.0.0/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_ModelCompose.md)
218+
|**Java** | [Model compose](https://github.com/Azure/azure-sdk-for-java/blob/afa0d44fa42979ae9ad9b92b23cdba493a562127/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/administration/ComposeDocumentModel.java)
219+
|**JavaScript** | [Compose model](https://github.com/witemple-msft/azure-sdk-for-js/blob/7e3196f7e529212a6bc329f5f06b0831bf4cc174/sdk/formrecognizer/ai-form-recognizer/samples/v4/javascript/composeModel.js)
220+
|**Python** | [Create composed model](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2/sample_compose_model.py)
221221

222222
#### Analyze documents
223223

224224
Once you've built your composed model, you can use it to analyze forms and documents. Use your composed `model ID` and let the service decide which of your aggregated custom models fits best according to the document provided.
225225

226226
|Programming language| Code sample |
227227
|--|--|
228-
|**C#** | [Analyze a document with a custom/composed model](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_AnalyzeWithCustomModel.md)
229-
|**Java** | [Analyze forms with your custom/composed model ](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AnalyzeCustomDocumentFromUrl.java)
230-
|**JavaScript** | [Analyze documents by model ID](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/samples/v4-beta/javascript/analyzeReceiptByModelId.js)
231-
|**Python** | [Analyze custom documents](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0b3/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_analyze_custom_documents.py)
228+
|**C#** | [Analyze a document with a custom/composed model using model ID](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_AnalyzeWithCustomModel.md)
229+
|**Java** | [Analyze a document with a custom/composed model using model ID](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AnalyzeCustomDocumentFromUrl.java)
230+
|**JavaScript** | [Analyze a document with a custom/composed model using model ID](https://github.com/witemple-msft/azure-sdk-for-js/blob/7e3196f7e529212a6bc329f5f06b0831bf4cc174/sdk/formrecognizer/ai-form-recognizer/samples/v4/javascript/analyzeDocumentByModelId.js)
231+
|**Python** | [Analyze a document with a custom/composed model using model ID](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2/sample_analyze_custom_documents.py)
232232

233233
## Manage your composed models
234234

235-
You can manage a custom model at each stage in its life cycles. You can view a list of all custom models under your subscription, retrieve information about a specific custom model, and delete custom models from your account.
235+
You can manage a custom model at each stage in its life cycles. You can copy a custom model between resources, view a list of all custom models under your subscription, retrieve information about a specific custom model, and delete custom models from your account.
236236

237237
|Programming language| Code sample |
238238
|--|--|
239-
|**C#** | [Analyze a document with a custom/composed model](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_AnalyzeWithCustomModel.md)|
240-
|**Java** | [Custom model management operations](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/administration/ManageCustomModels.java)|
241-
|**JavaScript** | [Get model types and schema](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/samples/v4-beta/javascript/getModel.js)|
242-
|**Python** | [Manage models](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0b3/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_manage_models.py)|
239+
|**C#** | [Copy a custom model between Form Recognizer resources](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample_CopyCustomModel.md#copy-a-custom-model-between-form-recognizer-resources)|
240+
|**Java** | [Copy a custom model between Form Recognizer resources](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/administration/CopyDocumentModel.java)|
241+
|**JavaScript** | [Copy a custom model between Form Recognizer resources](https://github.com/witemple-msft/azure-sdk-for-js/blob/7e3196f7e529212a6bc329f5f06b0831bf4cc174/sdk/formrecognizer/ai-form-recognizer/samples/v4/javascript/copyModel.js)|
242+
|**Python** | [Copy a custom model between Form Recognizer resources](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2/sample_copy_model_to.py)|
243243

244244
---
245245

articles/applied-ai-services/form-recognizer/concept-read.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,21 @@ Form Recognizer v3.0 includes the new Read Optical Character Recognition (OCR) m
2626
2727
| **Model** | **Images** | **PDF** | **TIFF** | **Word** | **Excel** | **PowerPoint** | **HTML** |
2828
| --- | --- | --- | --- | --- | --- | --- | --- |
29-
| Read | ||| ✓ (preview) | ✓ (preview) | ✓ (preview) | ✓ (preview) |
29+
| **prebuilt-read** | GA</br> (2022-08-31)| GA</br> (2022-08-31) | GA</br> (2022-08-31) | Preview</br>(2022-06-30-preview) | Preview</br>(2022-06-30-preview) | Preview</br>(2022-06-30-preview) | Preview</br>(2022-06-30-preview) |
3030

3131
### Data extraction
3232

33-
| **Read model** | **Text** | **[Language detection](language-support.md#detected-languages-read-api)** |
33+
| **Model** | **Text** | **[Language detection](language-support.md#detected-languages-read-api)** |
3434
| --- | --- | --- |
35-
prebuilt-read | ✓ |✓ |
35+
**prebuilt-read** | ✓ |✓ |
3636

3737
## Development options
3838

3939
The following resources are supported by Form Recognizer v3.0:
4040

41-
| Feature | Resources | Model ID |
41+
| Model | Resources | Model ID |
4242
|----------|------------|------------|
43-
|**Read model**| <ul><li>[**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com)</li><li>[**REST API**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-rest-api)</li><li>[**C# SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-csharp)</li><li>[**Python SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-python)</li><li>[**Java SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-java)</li><li>[**JavaScript**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-javascript)</li></ul>|**prebuilt-read**|
43+
|**prebuilt-read**| <ul><li>[**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com)</li><li>[**REST API**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-rest-api)</li><li>[**C# SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-csharp)</li><li>[**Python SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-python)</li><li>[**Java SDK**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-java)</li><li>[**JavaScript**](how-to-guides/use-prebuilt-read.md?pivots=programming-language-javascript)</li></ul>|**prebuilt-read**|
4444

4545
## Try Form Recognizer
4646

@@ -88,11 +88,11 @@ The Read model extracts all identified blocks of text in the `paragraphs` collec
8888

8989
```json
9090
"paragraphs": [
91-
{
92-
"spans": [],
93-
"boundingRegions": [],
94-
"content": "While healthcare is still in the early stages of its Al journey, we are seeing pharmaceutical and other life sciences organizations making major investments in Al and related technologies.\" TOM LAWRY | National Director for Al, Health and Life Sciences | Microsoft"
95-
}
91+
{
92+
"spans": [],
93+
"boundingRegions": [],
94+
"content": "While healthcare is still in the early stages of its Al journey, we are seeing pharmaceutical and other life sciences organizations making major investments in Al and related technologies.\" TOM LAWRY | National Director for Al, Health and Life Sciences | Microsoft"
95+
}
9696
]
9797
```
9898
### Language detection <sup>🆕</sup>
@@ -139,17 +139,17 @@ The page units in the model output are computed as shown:
139139

140140
```json
141141
"pages": [
142-
{
143-
"pageNumber": 1,
144-
"angle": 0,
145-
"width": 915,
146-
"height": 1190,
147-
"unit": "pixel",
148-
"words": [],
149-
"lines": [],
150-
"spans": [],
151-
"kind": "document"
152-
}
142+
{
143+
"pageNumber": 1,
144+
"angle": 0,
145+
"width": 915,
146+
"height": 1190,
147+
"unit": "pixel",
148+
"words": [],
149+
"lines": [],
150+
"spans": [],
151+
"kind": "document"
152+
}
153153
]
154154
```
155155

articles/applied-ai-services/form-recognizer/faq.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ metadata:
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: faq
10-
ms.date: 08/22/2022
10+
ms.date: 09/09/2022
1111
ms.author: lajanuar
1212

1313
title: Form Recognizer frequently asked questions
@@ -158,42 +158,42 @@ sections:
158158
159159
- [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio)
160160
161-
- [C#/.NET](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.0.0-beta.4)
161+
- [C#/.NET](https://www.nuget.org/packages/Azure.AI.FormRecognizer/4.0.0)
162162
163-
- [Java](https://search.maven.org/artifact/com.azure/azure-ai-formrecognizer/4.0.0-beta.5/jar)
163+
- [Java](https://oss.sonatype.org/#nexus-search;quick~azure-ai-formrecognizer)
164164
165165
- [JavaScript/TypeScript](https://www.npmjs.com/package/@azure/ai-form-recognizer/v/4.0.0-beta.4)
166166
167-
- [Python](https://pypi.org/project/azure-ai-formrecognizer/3.2.0b5/)
167+
- [Python](https://pypi.org/project/azure-ai-formrecognizer/3.2.0/)
168168
169169
- question: |
170170
Where can I find the supported API version for the latest programming language SDKs?
171171
answer: |
172172
173173
This table provides links to the latest SDK versions and shows the relationship between supported Form Recognizer SDK and API versions:
174174
175-
| Supported Language | Azure SDK client-library|API reference |Supported API version|
176-
| ----- | -----|-----|-----|
177-
| C#/.NET| [4.0.0-beta.5](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0-beta.5/index.html)|[.NET SDK](/dotnet/api/azure.ai.formrecognizer.documentanalysis?view=azure-dotnet&preserve-view=true) |2022-08-31-ga, 2022-06-30-preview, 2022-01-30-preview, 2021-09-30-preview, v2.1-ga, v2.0 |
178-
| Java | [4.0.0-beta.6](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0-beta.6/index.html)|[Java SDK](/java/api/overview/azure/ai-formrecognizer-readme?view=azure-java-stable&preserve-view=true)| 2022-08-31-ga, 2022-06-30-preview, 2022-01-30-preview, 2021-09-30-preview, v2.1-ga, v2.0|
179-
| JavaScript | [4.0.0-beta.6](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-ai-form-recognizer/4.0.0-beta.6/index.html)|[JavaScript SDK](/javascript/api/@azure/ai-form-recognizer/?view=azure-node-latest&preserve-view=true) |2022-08-31-ga, 2022-06-30-preview, 2022-01-30-preview, 2021-09-30-preview, v2.1-ga, v2.0|
180-
| Python | [3.2.0b6](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-formrecognizer/3.2.0b6/index.html) |[Python SDK](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer?view=azure-python&preserve-view=true) |2022-08-31-ga, 2022-06-30-preview, 2022-01-30-preview, 2021-09-30-preview, v2.1-ga, v2.0|
175+
| Supported Language | Azure SDK reference|Supported API version|
176+
| ----- | -----|-----|
177+
| C#/.NET| [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0/index.html)|[**v3.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) | [[Windows, macOS, Linux, Docker](https://dotnet.microsoft.com/download) |
178+
| Java | [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0/index.html)| [**v3.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) | [[Windows, macOS, Linux](/java/openjdk/install) |
179+
| JavaScript | [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-ai-form-recognizer/4.0.0/index.html)|[**v3.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) | [Browser, Windows, macOS, Linux](https://nodejs.org/en/download/) |
180+
| Python | [3.2.0](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-formrecognizer/3.2.0/index.html) |[**v3.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) | [Windows, macOS, Linux](/azure/developer/python/configure-local-development-environment?tabs=windows%2Capt%2Ccmd#use-the-azure-cli) |
181181
182182
- question: |
183183
What is the difference between Form Recognizer v3.0 and v2.1 and how do I migrate to the latest version?
184184
answer: |
185185
186-
For improved usability, Form Recognizer v3.0 introduces a fully redesigned client library. To successfully use the latest Form Recognizer API features—version 2021-09-30-preview and newer, the most recent SDK is required and your application code must be updated to use the new clients.
186+
For improved usability, Form Recognizer v3.0 introduces a fully redesigned client library. To successfully use the latest Form Recognizer API features, the most recent SDK is required and your application code must be updated to use the new clients.
187187
188188
This table provides links to detailed instructions for migrating to the newest version of Form Recognizer:
189189
190190
| Language / API | Migration guide|
191191
| ----------- | ---------------- |
192192
| REST API | [v3](v3-migration-guide.md)|
193-
| C#/.NET| [4.0.0-beta.5](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/MigrationGuide.md)|
194-
| Java | [4.0.0-beta.6](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md)|
195-
| JavaScript| [4.0.0-beta.6](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/formrecognizer/ai-form-recognizer/MIGRATION-v3_v4.md)|
196-
| Python | [3.2.0b6](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md)|
193+
| C#/.NET| [4.0.0](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.FormRecognizer_4.0.0/sdk/formrecognizer/Azure.AI.FormRecognizer/MigrationGuide.md)|
194+
| Java | [4.0.0](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md)|
195+
| JavaScript| [4.0.0](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md)|
196+
| Python | [3.2.0](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md)|
197197
198198
- question: |
199199
Which file formats does Form Recognizer support? Are there size limitations for input documents?
@@ -237,7 +237,7 @@ sections:
237237
- When you submit a document for analysis, all pages are analyzed unless you specify a page range with the `pages` parameter in your request. When the service analyzes Microsoft Excel and PowerPoint documents with the new Read OCR model, each worksheet and slide is counted as one page respectively.
238238
239239
- When analyzing PDF and TIFF files, each page in the PDF file or each image in the TIFF file is counted as one page with no maximum character limits.
240-
240+
241241
- When analyzing Microsoft Word and HTML files supported by only the Read model, pages are counted 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 will add up to a total of three pages.
242242
243243
- In addition, when using the Read model, if your Microsoft Word, Excel, and PowerPoint pages have embedded images, each image will be analyzed and counted as a page. Therefore, the total analyzed pages for Microsoft Office documents will be equal to the sum of total text pages and total images analyzed. In the previous example if the document contains 2 embedded images, the total page count in the service output will be three text pages plus two images equaling a total of five pages.

0 commit comments

Comments
 (0)