Skip to content

Commit ce4d5de

Browse files
authored
Merge pull request #208567 from MicrosoftDocs/release-form-recognizer-v3-ga
Release form recognizer v3 ga
2 parents 72d8420 + 728d08c commit ce4d5de

File tree

60 files changed

+1327
-1114
lines changed

Some content is hidden

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

60 files changed

+1327
-1114
lines changed

articles/app-service/tutorial-python-postgresql-app.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Tutorial: Deploy a Python Django or Flask web app with PostgreSQL'
33
description: Create a Python Django or Flask web app with a PostgreSQL database and deploy it to Azure. The tutorial uses either the Django or Flask framework and the app is hosted on Azure App Service on Linux.
4-
author: SQLDataNinja
4+
author: jessmjohnson
55
ms.author: jejohn
66
ms.devlang: python
77
ms.topic: tutorial
@@ -223,7 +223,7 @@ Having issues? [Let us know](https://aka.ms/DjangoCLITutorialHelp).
223223

224224
## 4 - Allow web app to access the database
225225

226-
After the Azure Database for PostgreSQL server is created, configure access to the server from the web app by adding a firewall rule. This can be done through the Azure portal or the Azure CLI.
226+
After the Azure Database for PostgreSQL server is created, configure access to the server from the web app by adding a firewall rule. This can be done through the Azure portal or the Azure CLI.
227227

228228
If you're working in VS Code, right-click the database server and select **Open in Portal** to go to the Azure portal. Or, go to the [Azure Cloud Shell](https://shell.azure.com) and run the Azure CLI commands.
229229
### [Azure portal](#tab/azure-portal-access)
@@ -429,7 +429,6 @@ Follow these steps while signed-in to the Azure portal to delete a resource grou
429429
| [!INCLUDE [Remove resource group Azure portal 2](<./includes/tutorial-python-postgresql-app/remove-resource-group-azure-portal-2.md>)] | :::image type="content" source="./media/tutorial-python-postgresql-app/remove-resource-group-azure-portal-2-240px.png" lightbox="./media/tutorial-python-postgresql-app/remove-resource-group-azure-portal-2.png" alt-text="A screenshot showing how to delete a resource group in the Azure portal." ::: |
430430
| [!INCLUDE [Remove resource group Azure portal 3](<./includes/tutorial-python-postgresql-app/remove-resource-group-azure-portal-3.md>)] | |
431431

432-
433432
### [VS Code](#tab/vscode-aztools)
434433

435434
| Instructions | Screenshot |
@@ -441,7 +440,7 @@ Follow these steps while signed-in to the Azure portal to delete a resource grou
441440

442441
[!INCLUDE [Stream logs CLI](<./includes/tutorial-python-postgresql-app/clean-up-resources-cli.md>)]
443442

444-
----
443+
---
445444

446445
Having issues? [Let us know](https://aka.ms/DjangoCLITutorialHelp).
447446

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

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,52 @@
4949
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/tutorial-ai-builder.md",
5050
"redirect_url": "/ai-builder/create-form-processing-model",
5151
"redirect_document_id": false
52-
}
52+
},
53+
{
54+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/how-to-guides/try-sdk-rest-api.md",
55+
"redirect_url": "/azure/applied-ai-services/form-recognizer/how-to-guides/try-v2-1-sdk-rest-api",
56+
"redirect_document_id": false
57+
},
58+
{
59+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/try-v3-rest-api.md",
60+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v3-sdk-rest-api",
61+
"redirect_document_id": false
62+
},{
63+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/try-v3-csharp-sdk.md",
64+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v3-sdk-rest-api",
65+
"redirect_document_id": false
66+
},{
67+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/try-v3-java-sdk.md",
68+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v3-sdk-rest-api",
69+
"redirect_document_id": false
70+
},{
71+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/try-v3-javascript-sdk.md",
72+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v3-sdk-rest-api",
73+
"redirect_document_id": false
74+
},{
75+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/try-v3-python-sdk.md",
76+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v3-sdk-rest-api",
77+
"redirect_document_id": false
78+
},
79+
{
80+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/quickstarts/get-started-sdk-rest-api.md",
81+
"redirect_url": "/azure/applied-ai-services/form-recognizer/quickstarts/get-started-v2.1-sdk-rest-api",
82+
"redirect_document_id": false
83+
},
84+
{
85+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/preview-error-guide.md",
86+
"redirect_url": "/azure/applied-ai-services/form-recognizer/v3-error-guide",
87+
"redirect_document_id": false
88+
},
89+
{
90+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/compose-custom-models-preview.md",
91+
"redirect_url": "/azure/applied-ai-services/form-recognizer/compose-custom-models-v3",
92+
"redirect_document_id": false
93+
},
94+
{
95+
"source_path_from_root": "/articles/applied-ai-services/form-recognizer/compose-custom-models.md",
96+
"redirect_url": "/azure/applied-ai-services/form-recognizer/compose-custom-models-v2-1",
97+
"redirect_document_id": false
98+
}
5399
]
54-
}
100+
}

articles/applied-ai-services/form-recognizer/compose-custom-models.md renamed to articles/applied-ai-services/form-recognizer/compose-custom-models-v2-1.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 06/06/2022
10+
ms.date: 08/22/2022
1111
ms.author: lajanuar
1212
recommendations: false
1313
---
1414

1515
# Compose custom models v2.1
1616

1717
> [!NOTE]
18-
> This how-to guide references Form Recognizer v2.1 (GA). To try Form Recognizer v3.0 (preview), see [Compose custom models v3.0 (preview)](compose-custom-models-preview.md).
18+
> This how-to guide references Form Recognizer v2.1 . To try Form Recognizer v3.0 , see [Compose custom models v3.0](compose-custom-models-v3.md).
1919
2020
Form Recognizer uses advanced machine-learning technology to detect and extract information from document images and return the extracted data in a structured JSON output. With Form Recognizer, you can train standalone custom models or combine custom models to create composed models.
2121

@@ -146,7 +146,7 @@ When the operation completes, your newly composed model will appear in the list.
146146

147147
### [**REST API**](#tab/rest-api)
148148

149-
Using the **REST API**, you can make a [**Compose Custom Model**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/ComposeDocumentModel) request to create a single composed model from existing models. The request body requires a string array of your `modelIds` to compose and you can optionally define the `modelName`.
149+
Using the **REST API**, you can make a [**Compose Custom Model**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/ComposeDocumentModel) request to create a single composed model from existing models. The request body requires a string array of your `modelIds` to compose and you can optionally define the `modelName`.
150150

151151
### [**Client-library SDKs**](#tab/sdks)
152152

@@ -180,7 +180,7 @@ Use the programming language code of your choice to create a composed model that
180180

181181
### [**REST API**](#tab/rest-api)
182182

183-
Using the REST API, you can make an [Analyze Document](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument) request to analyze a document and extract key-value pairs and table data.
183+
Using the REST API, you can make an [Analyze Document](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) request to analyze a document and extract key-value pairs and table data.
184184

185185
### [**Client-library SDKs**](#tab/sdks)
186186

@@ -200,7 +200,7 @@ Test your newly trained models by [analyzing forms](./quickstarts/try-sdk-rest-a
200200

201201
## Manage your custom models
202202

203-
You can [manage your custom models](./quickstarts/try-sdk-rest-api.md#manage-custom-models) throughout their lifecycle by viewing a [list of all custom models](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/GetModels) under your subscription, retrieving information about [a specific custom model](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/GetModel), and [deleting custom models](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/DeleteModel) from your account.
203+
You can [manage your custom models](./quickstarts/try-sdk-rest-api.md#manage-custom-models) throughout their lifecycle by viewing a [list of all custom models](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/GetModels) under your subscription, retrieving information about [a specific custom model](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/GetModel), and [deleting custom models](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/DeleteModel) from your account.
204204

205205
Great! You've learned the steps to create custom and composed models and use them in your Form Recognizer projects and applications.
206206

@@ -209,5 +209,5 @@ Great! You've learned the steps to create custom and composed models and use the
209209
Learn more about the Form Recognizer client library by exploring our API reference documentation.
210210

211211
> [!div class="nextstepaction"]
212-
> [Form Recognizer API reference](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)
212+
> [Form Recognizer API reference](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument)
213213
>

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 06/06/2022
10+
ms.date: 08/22/2022
1111
ms.author: lajanuar
1212
recommendations: false
1313
---
1414

15-
# Compose custom models v3.0 | Preview
15+
# Compose custom models v3.0
1616

1717
> [!NOTE]
18-
> This how-to guide references Form Recognizer v3.0 (preview). To use Form Recognizer v2.1 (GA), see [Compose custom models v2.1](compose-custom-models.md).
18+
> This how-to guide references Form Recognizer v3.0 . To use Form Recognizer v2.1 , see [Compose custom models v2.1](compose-custom-models-v2-1.md).
1919
2020
A composed model is created by taking a collection of custom models and assigning them to a single model ID. You can assign up to 100 trained custom models to a single composed model ID. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis. Composed models are useful when you've trained several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
2121

@@ -74,7 +74,7 @@ If you want to use manually labeled data, you'll also have to upload the *.label
7474

7575
When you [train your model](https://formrecognizer.appliedai.azure.com/studio/custommodel/projects) with labeled data, the model uses supervised learning to extract values of interest, using the labeled forms you provide. Labeled data results in better-performing models and can produce models that work with complex forms or forms containing values without keys.
7676

77-
Form Recognizer uses the [prebuilt-layout model](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument) API to learn the expected sizes and positions of typeface and handwritten text elements and extract tables. Then it uses user-specified labels to learn the key/value associations and tables in the documents. We recommend that you use five manually labeled forms of the same type (same structure) to get started with training a new model. Then, add more labeled data, as needed, to improve the model accuracy. Form Recognizer enables training a model to extract key-value pairs and tables using supervised learning capabilities.
77+
Form Recognizer uses the [prebuilt-layout model](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) API to learn the expected sizes and positions of typeface and handwritten text elements and extract tables. Then it uses user-specified labels to learn the key/value associations and tables in the documents. We recommend that you use five manually labeled forms of the same type (same structure) to get started with training a new model. Then, add more labeled data, as needed, to improve the model accuracy. Form Recognizer enables training a model to extract key-value pairs and tables using supervised learning capabilities.
7878

7979
### [Form Recognizer Studio](#tab/studio)
8080

@@ -114,10 +114,10 @@ Training with labels leads to better performance in some scenarios. To train wit
114114

115115
|Language |Method|
116116
|--|--|
117-
|**C#**|[**StartBuildModel**](/dotnet/api/azure.ai.formrecognizer.documentanalysis.documentmodeladministrationclient.startbuildmodel?view=azure-dotnet-preview#azure-ai-formrecognizer-documentanalysis-documentmodeladministrationclient-startbuildmodel&preserve-view=true)|
117+
|**C#**|[**StartBuildModel**](/dotnet/api/azure.ai.formrecognizer.documentanalysis.documentmodeladministrationclient.startbuildmodel?view=azure-dotnet#azure-ai-formrecognizer-documentanalysis-documentmodeladministrationclient-startbuildmodel&preserve-view=true)|
118118
|**Java**| [**beginBuildModel**](/java/api/com.azure.ai.formrecognizer.administration.documentmodeladministrationclient.beginbuildmodel?view=azure-java-preview&preserve-view=true)|
119-
|**JavaScript** | [**beginBuildModel**](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-preview#@azure-ai-form-recognizer-documentmodeladministrationclient-beginbuildmodel&preserve-view=true)|
120-
| **Python** | [**begin_build_model**](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.documentmodeladministrationclient?view=azure-python-preview#azure-ai-formrecognizer-aio-documentmodeladministrationclient-begin-build-model&preserve-view=true)
119+
|**JavaScript** | [**beginBuildModel**](/javascript/api/@azure/ai-form-recognizer/documentmodeladministrationclient?view=azure-node-latest#@azure-ai-form-recognizer-documentmodeladministrationclient-beginbuildmodel&preserve-view=true)|
120+
| **Python** | [**begin_build_model**](/python/api/azure-ai-formrecognizer/azure.ai.formrecognizer.aio.documentmodeladministrationclient?view=azure-python#azure-ai-formrecognizer-aio-documentmodeladministrationclient-begin-build-model&preserve-view=true)
121121

122122
---
123123

@@ -126,7 +126,7 @@ Training with labels leads to better performance in some scenarios. To train wit
126126
> [!NOTE]
127127
> **the `create compose model` operation is only available for custom models trained _with_ labels.** Attempting to compose unlabeled models will produce an error.
128128
129-
With the [**create compose model**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/ComposeDocumentModel) operation, you can assign up to 100 trained custom models to a single model ID. When analyze documents with a composed model, Form Recognizer first classifies the form you submitted, then chooses the best matching assigned model, and returns results for that model. This operation is useful when incoming forms may belong to one of several templates.
129+
With the [**create compose model**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/ComposeDocumentModel) operation, you can assign up to 100 trained custom models to a single model ID. When analyze documents with a composed model, Form Recognizer first classifies the form you submitted, then chooses the best matching assigned model, and returns results for that model. This operation is useful when incoming forms may belong to one of several templates.
130130

131131
### [Form Recognizer Studio](#tab/studio)
132132

@@ -186,19 +186,19 @@ Once the training process has successfully completed, you can begin to build you
186186

187187
#### Compose your custom models
188188

189-
The [compose model API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/ComposeDocumentModel) accepts a list of model IDs to be composed.
189+
The [compose model API](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/ComposeDocumentModel) accepts a list of model IDs to be composed.
190190

191191
:::image type="content" source="media/compose-model-request-body.png" alt-text="Screenshot of compose model request.":::
192192

193193
#### Analyze documents
194194

195-
To make an [**Analyze document**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument) request, use a unique model name in the request parameters.
195+
To make an [**Analyze document**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument) request, use a unique model name in the request parameters.
196196

197197
:::image type="content" source="media/custom-model-analyze-request.png" alt-text="Screenshot of a custom model request URL.":::
198198

199199
#### Manage your composed models
200200

201-
You can manage custom models throughout your development needs including [**copying**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/CopyDocumentModelTo), [**listing**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/GetModels), and [**deleting**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/DeleteModel) your models.
201+
You can manage custom models throughout your development needs including [**copying**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/CopyDocumentModelTo), [**listing**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/GetModels), and [**deleting**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/DeleteModel) your models.
202202

203203
### [Client-libraries](#tab/sdks)
204204

@@ -232,7 +232,7 @@ Once you've built your composed model, you can use it to analyze forms and docum
232232

233233
## Manage your composed models
234234

235-
You can manage a custom models 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 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
|--|--|
@@ -251,16 +251,16 @@ Try one of our Form Recognizer quickstarts:
251251
> [Form Recognizer Studio](quickstarts/try-v3-form-recognizer-studio.md)
252252
253253
> [!div class="nextstepaction"]
254-
> [REST API](quickstarts/try-v3-rest-api.md)
254+
> [REST API](quickstarts/get-started-v3-sdk-rest-api.md)
255255
256256
> [!div class="nextstepaction"]
257-
> [C#](quickstarts/try-v3-csharp-sdk.md)
257+
> [C#](quickstarts/get-started-v3-sdk-rest-api.md#prerequisites)
258258
259259
> [!div class="nextstepaction"]
260-
> [Java](quickstarts/try-v3-java-sdk.md)
260+
> [Java](quickstarts/get-started-v3-sdk-rest-api.md)
261261
262262
> [!div class="nextstepaction"]
263-
> [JavaScript](quickstarts/try-v3-javascript-sdk.md)
263+
> [JavaScript](quickstarts/get-started-v3-sdk-rest-api.md)
264264
265265
> [!div class="nextstepaction"]
266-
> [Python](quickstarts/try-v3-python-sdk.md)
266+
> [Python](quickstarts/get-started-v3-sdk-rest-api.md)

0 commit comments

Comments
 (0)