Skip to content

Commit aaf8200

Browse files
authored
Merge pull request #219817 from laujan/44716-remove-container-refs-from-v3
remove preview references from containers → v2.1 view
2 parents 11f03b0 + 86e0995 commit aaf8200

File tree

5 files changed

+55
-39
lines changed

5 files changed

+55
-39
lines changed

articles/applied-ai-services/form-recognizer/containers/form-recognizer-container-configuration.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 10/20/2022
10+
ms.date: 11/29/2022
1111
ms.author: lajanuar
12-
monikerRange: '>=form-recog-2.1.0'
12+
monikerRange: 'form-recog-2.1.0'
1313
recommendations: false
1414
---
1515
# Configure Form Recognizer containers
1616

17+
**This article applies to:** ![Form Recognizer v2.1 checkmark](../media/yes-icon.png) **Form Recognizer v2.1**.
18+
1719
> [!IMPORTANT]
1820
>
19-
> Form Recognizer containers are in gated preview. To use them, you must submit an [online request](https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUNlpBU1lFSjJUMFhKNzVHUUVLN1NIOEZETiQlQCN0PWcu), and have it approved. For more information, See [**Request approval to run container**](form-recognizer-container-install-run.md#request-approval-to-run-the-container).
21+
> Form Recognizer containers are in gated release. To use them, you must submit an [online request](https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUNlpBU1lFSjJUMFhKNzVHUUVLN1NIOEZETiQlQCN0PWcu), and have it approved. For more information, See [**Request approval to run container**](form-recognizer-container-install-run.md#request-approval-to-run-the-container).
2022
2123
With Azure Form Recognizer containers, you can build an application architecture that's optimized to take advantage of both robust cloud capabilities and edge locality. Containers provide a minimalist, isolated environment that can be easily deployed on-premises and in the cloud. In this article, you'll learn to configure the Form Recognizer container run-time environment by using the `docker compose` command arguments. Form Recognizer features are supported by six Form Recognizer feature containers—**Layout**, **Business Card**,**ID Document**, **Receipt**, **Invoice**, **Custom**. These containers have both required and optional settings. For a few examples, see the [Example docker-compose.yml file](#example-docker-composeyml-file) section.
2224

@@ -149,3 +151,5 @@ networks:
149151
150152
> [!div class="nextstepaction"]
151153
> [Learn more about running multiple containers and the docker compose command](form-recognizer-container-install-run.md)
154+
155+
* [Azure container instance recipe](../../../cognitive-services/containers/azure-container-instance-recipe.md)

articles/applied-ai-services/form-recognizer/containers/form-recognizer-container-image-tags.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: reference
10-
ms.date: 10/20/2022
10+
ms.date: 11/29/2022
1111
ms.author: lajanuar
12-
monikerRange: '>=form-recog-2.1.0'
12+
monikerRange: 'form-recog-2.1.0'
1313
recommendations: false
1414
---
1515

1616
# Form Recognizer container image tags and release notes
1717

18+
**This article applies to:** ![Form Recognizer v2.1 checkmark](../media/yes-icon.png) **Form Recognizer v2.1**.
19+
1820
> [!IMPORTANT]
1921
>
20-
> * **Form Recognizer v2.1 containers** are in gated preview. To use them, you must submit an [online request](https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUNlpBU1lFSjJUMFhKNzVHUUVLN1NIOEZETiQlQCN0PWcu), and receive approval.
22+
> * **Form Recognizer v2.1 containers** are in gated release. To use them, you must submit an [online request](https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUNlpBU1lFSjJUMFhKNzVHUUVLN1NIOEZETiQlQCN0PWcu), and receive approval.
2123
>
2224
> * The online request form requires that you provide a valid email address that belongs to the organization that owns the Azure subscription ID and that you have or have been granted access to that subscription.
2325
@@ -49,17 +51,17 @@ The following tags are available for Form Recognizer:
4951

5052
### [Latest version](#tab/current)
5153

52-
Release notes for `v2.1` (gated preview):
54+
Release notes for `v2.1`:
5355

5456
| Container | Tags | Retrieve image |
5557
|------------|:------|------------|
56-
| **Layout**| &bullet; `latest` </br> &bullet; `2.1-preview`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/layout)`|
57-
| **Business Card** | &bullet; `latest` </br> &bullet; `2.1-preview` |`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/receipt` |
58-
| **ID Document** | &bullet; `latest` </br> &bullet; `2.1-preview`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/id-document`|
59-
| **Receipt**| &bullet; `latest` </br> &bullet; `2.1-preview`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/receipt` |
60-
| **Invoice**| &bullet; `latest` </br> &bullet; `2.1-preview`|`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice` |
61-
| **Custom API** | &bullet; `latest` </br> &bullet; `2.1-preview`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/custom-api`|
62-
| **Custom Supervised**| &bullet; `latest` </br> &bullet; `2.1-preview`|`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/custom-supervised` |
58+
| **Layout**| &bullet; `latest` </br> &bullet; `2.1`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/layout)`|
59+
| **Business Card** | &bullet; `latest` </br> &bullet; `2.1` |`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/receipt` |
60+
| **ID Document** | &bullet; `latest` </br> &bullet; `2.1`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/id-document`|
61+
| **Receipt**| &bullet; `latest` </br> &bullet; `2.1`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/receipt` |
62+
| **Invoice**| &bullet; `latest` </br> &bullet; `2.1`|`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice` |
63+
| **Custom API** | &bullet; `latest` </br> &bullet; `2.1`| `docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/custom-api`|
64+
| **Custom Supervised**| &bullet; `latest` </br> &bullet; `2.1`|`docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/custom-supervised` |
6365

6466
### [Previous versions](#tab/previous)
6567

@@ -73,3 +75,5 @@ Release notes for `v2.1` (gated preview):
7375
> [!div class="nextstepaction"]
7476
> [Install and run Form Recognizer containers](form-recognizer-container-install-run.md)
7577
>
78+
79+
* [Azure container instance recipe](../../../cognitive-services/containers/azure-container-instance-recipe.md)

articles/applied-ai-services/form-recognizer/containers/form-recognizer-container-install-run.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,19 @@ manager: nitinme
77
ms.service: applied-ai-services
88
ms.subservice: forms-recognizer
99
ms.topic: how-to
10-
ms.date: 10/20/2022
10+
ms.date: 11/29/2022
1111
ms.author: lajanuar
12-
monikerRange: '>=form-recog-2.1.0'
12+
monikerRange: 'form-recog-2.1.0'
1313
recommendations: false
1414
---
1515

16-
# Install and run Form Recognizer v2.1-preview containers
16+
# Install and run Form Recognizer v2.1 containers
17+
18+
**This article applies to:** ![Form Recognizer v2.1 checkmark](../media/yes-icon.png) **Form Recognizer v2.1**.
1719

1820
> [!IMPORTANT]
1921
>
20-
> * Form Recognizer containers are in gated preview. To use them, you must submit an [online request](https://aka.ms/csgate), and receive approval. For more information, *see* [**Request approval to run container**](#request-approval-to-run-the-container) below.
22+
> * Form Recognizer containers are in gated release. To use them, you must submit an [online request](https://aka.ms/csgate), and receive approval. For more information, *see* [**Request approval to run container**](#request-approval-to-run-the-container) below.
2123
>
2224
> * The online request form requires that you provide a valid email address that belongs to the organization that owns the Azure subscription ID and that you have or have been granted access to that subscription.
2325
@@ -84,21 +86,21 @@ The following table lists the supporting container(s) for each Form Recognizer c
8486

8587
| Container | Minimum | Recommended |
8688
|-----------|---------|-------------|
87-
| Read 3.2 | 8 cores, 16-GB memory | 8 cores, 24-GB memory|
88-
| Layout 2.1-preview | 8 cores, 16-GB memory | 8 cores, 24-GB memory |
89-
| Business Card 2.1-preview | 2 cores, 4-GB memory | 4 cores, 4-GB memory |
90-
| ID Document 2.1-preview | 1 core, 2-GB memory |2 cores, 2-GB memory |
91-
| Invoice 2.1-preview | 4 cores, 8-GB memory | 8 cores, 8-GB memory |
92-
| Receipt 2.1-preview | 4 cores, 8-GB memory | 8 cores, 8-GB memory |
89+
| Read 3.2 | `8` cores, 16-GB memory | `8` cores, 24-GB memory|
90+
| Layout 2.1 | `8` cores, 16-GB memory | `8` cores, 24-GB memory |
91+
| Business Card 2.1 | `2` cores, 4-GB memory | `4` cores, 4-GB memory |
92+
| ID Document 2.1 | `1` core, 2-GB memory |`2` cores, 2-GB memory |
93+
| Invoice 2.1 | `4` cores, 8-GB memory | `8` cores, 8-GB memory |
94+
| Receipt 2.1 | `4` cores, 8-GB memory | `8` cores, 8-GB memory |
9395

9496
##### Custom containers
9597

9698
The following host machine requirements are applicable to **train and analyze** requests:
9799

98100
| Container | Minimum | Recommended |
99101
|-----------|---------|-------------|
100-
| Custom API| 0.5 cores, 0.5-GB memory| 1 cores, 1-GB memory |
101-
|Custom Supervised | 4 cores, 2-GB memory | 8 cores, 4-GB memory|
102+
| Custom API| 0.5 cores, 0.5-GB memory| `1` core, 1-GB memory |
103+
|Custom Supervised | `4` cores, 2-GB memory | `8` cores, 4-GB memory|
102104

103105
* Each core must be at least 2.6 gigahertz (GHz) or faster.
104106
* Core and memory correspond to the `--cpus` and `--memory` settings, which are used as part of the `docker compose` or `docker run` command.
@@ -324,7 +326,7 @@ In addition to the [prerequisites](#prerequisites) mentioned above, you'll need
324326
#### &bullet; Create a folder to store the following files:
325327

326328
1. [**.env**](#-create-an-environment-file)
327-
1. [**nginx.conf**](#-create-a-nginx-file)
329+
1. [**nginx.conf**](#-create-an-nginx-file)
328330
1. [**docker-compose.yml**](#-create-a-docker-compose-file)
329331

330332
#### &bullet; Create a folder to store your input data
@@ -355,7 +357,7 @@ In addition to the [prerequisites](#prerequisites) mentioned above, you'll need
355357
NGINX_CONF_FILE="<file-path>"
356358
```
357359

358-
#### &bullet; Create a **nginx** file
360+
#### &bullet; Create an **nginx** file
359361

360362
1. Name this file **nginx.conf**.
361363

@@ -622,4 +624,6 @@ That's it! In this article, you learned concepts and workflows for downloading,
622624
623625
## Next steps
624626

625-
* [Form Recognizer container configuration settings](form-recognizer-container-configuration.md)
627+
* [Form Recognizer container configuration settings](form-recognizer-container-configuration.md)
628+
629+
* [Azure container instance recipe](../../../cognitive-services/containers/azure-container-instance-recipe.md)

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,6 @@ items:
8787
- name: Container image tags
8888
displayName: registry, mcr
8989
href: containers/form-recognizer-container-image-tags.md
90-
- name: Use container instances
91-
href: ../../cognitive-services/containers/azure-container-instance-recipe.md
9290
- name: Configure secure communications
9391
items:
9492
- name: Set up Virtual Networks
@@ -133,30 +131,30 @@ items:
133131
- name: Model overview
134132
displayName: get started, prebuilt, extraction, input
135133
href: concept-model-overview.md
136-
- name: Form Recognizer Studio
134+
- name: Form Recognizer Studio
137135
href: concept-form-recognizer-studio.md
138136
- name: Read OCR model
139137
displayName: text
140138
href: concept-read.md
141139
- name: General document model
142140
displayName: key value pairs, selection marks, structured
143141
href: concept-general-document.md
144-
- name: Layout model
142+
- name: Layout model
145143
displayName: tables, selection marks, structure, paragraph roles, text, headers, page numbers
146144
href: concept-layout.md
147145
- name: W-2 form model
148146
displayName: wages, taxes, salary, employees
149147
href: concept-w2.md
150-
- name: Invoice model
148+
- name: Invoice model
151149
displayName: sales, vendors, VAT
152150
href: concept-invoice.md
153-
- name: Receipt model
151+
- name: Receipt model
154152
displayName: sales, merchants
155153
href: concept-receipt.md
156-
- name: ID document model
154+
- name: ID document model
157155
displayName: passport, visa, ID, social security, green card
158156
href: concept-id-document.md
159-
- name: Business card model
157+
- name: Business card model
160158
displayName: https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument
161159
href: concept-business-card.md
162160
- name: Custom models
@@ -202,7 +200,7 @@ items:
202200
href: tutorial-azure-function.md
203201
- name: Reference
204202
items:
205-
- name: REST API v3.0
203+
- name: REST API v3.0
206204
href: https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-08-31/operations/AnalyzeDocument
207205
- name: Error codes and messages v3.0
208206
href: v3-error-guide.md

articles/applied-ai-services/form-recognizer/whats-new.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,16 @@ Form Recognizer service is updated on an ongoing basis. Bookmark this page to st
2727
>[!NOTE]
2828
> With the release of the 2022-08-31 GA API, the associated preview APIs are being deprecated. If you are using the 2021-09-30-preview or the 2022-01-30-preview API versions, please update your applications to target the 2022-08-31 API version. There are a few minor changes involved, for more information, _see_ the [migration guide](v3-migration-guide.md).
2929
30-
## October 2022
30+
## November 2022
31+
32+
* **Announcing the latest stable release of Azure Form Recognizer libraries**
33+
* This release includes important changes and updates for .NET, Java, JavaScript, and Python SDKs. For more information, _see_ [**Azure SDK DevBlog**](https://devblogs.microsoft.com/azure-sdk/announcing-new-stable-release-of-azure-form-recognizer-libraries/).
34+
* The most significant enhancements are the introduction of two new clients, the **`DocumentAnalysisClient`** and the **`DocumentModelAdministrationClient`**.
3135

3236
---
3337

38+
## October 2022
39+
3440
* **Form Recognizer versioned content**
3541
* Form Recognizer documentation has been updated to present a versioned experience. Now, you can choose to view content targeting the v3.0 GA experience or the v2.1 GA experience. The v3.0 experience is the default.
3642

0 commit comments

Comments
 (0)