Skip to content

Commit 37fadeb

Browse files
Merge pull request #226986 from laujan/patch-199
Update form-recognizer-disconnected-containers.md
2 parents 4d985b5 + 19378fc commit 37fadeb

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

articles/applied-ai-services/form-recognizer/containers/form-recognizer-disconnected-containers.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,15 @@ ms.subservice: forms-recognizer
77
author: laujan
88
manager: nitinme
99
ms.topic: reference
10-
ms.date: 01/23/2023
10+
ms.date: 02/10/2023
1111
ms.author: lajanuar
12+
monikerRange: 'form-recog-2.1.0'
13+
recommendations: false
1214
---
1315

14-
# Use Form Recognizer containers in disconnected environments
16+
# Form Recognizer containers in disconnected environments
17+
18+
**This article applies to:** ![Form Recognizer v2.1 checkmark](../media/yes-icon.png) **Form Recognizer v2.1**.
1519

1620
<!-- markdownlint-disable MD036 -->
1721
<!-- markdownlint-disable MD001 -->
@@ -23,7 +27,7 @@ Azure Cognitive Services Form Recognizer containers allow you to use Form Recogn
2327
Before attempting to run a Docker container in an offline environment, make sure you're familiar with the following requirements to successfully download and use the container:
2428

2529
* Host computer requirements and recommendations.
26-
* The Docker `pull` command you'll use to download the container.
30+
* The Docker `pull` command to download the container.
2731
* How to validate that a container is running.
2832
* How to send queries to the container's endpoint, once it's running.
2933

@@ -89,19 +93,19 @@ docker pull mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice:l
8993

9094
## Configure the container to be run in a disconnected environment
9195

92-
Now that you've downloaded your container, you'll need to execute the `docker run` command with the following parameter:
96+
Now that you've downloaded your container, you need to execute the `docker run` command with the following parameter:
9397

94-
* **`DownloadLicense=True`**. This parameter will download a license file that will enable your Docker container to run when it isn't connected to the internet. It also contains an expiration date, after which the license file will be invalid to run the container. You can only use the license file in corresponding approved container.
98+
* **`DownloadLicense=True`**. This parameter downloads a license file that enables your Docker container to run when it isn't connected to the internet. It also contains an expiration date, after which the license file is invalid to run the container. You can only use the license file in corresponding approved container.
9599

96100
> [!IMPORTANT]
97101
>The `docker run` command will generate a template that you can use to run the container. The template contains parameters you'll need for the downloaded models and configuration file. Make sure you save this template.
98102
99-
The following example shows the formatting for the `docker run` command you'll use, with placeholder values. Replace these placeholder values with your own values.
103+
The following example shows the formatting for the `docker run` command to use with placeholder values. Replace these placeholder values with your own values.
100104

101105
| Placeholder | Value | Format or example |
102106
|-------------|-------|---|
103107
| `{IMAGE}` | The container image you want to use. | `mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice` |
104-
| `{LICENSE_MOUNT}` | The path where the license will be downloaded, and mounted. | `/host/license:/path/to/license/directory` |
108+
| `{LICENSE_MOUNT}` | The path where the license is downloaded, and mounted. | `/host/license:/path/to/license/directory` |
105109
| `{ENDPOINT_URI}` | The endpoint for authenticating your service request. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
106110
| `{API_KEY}` | The key for your Text Analytics resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |`{string}`|
107111
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem. | `/path/to/license/directory` |
@@ -152,7 +156,7 @@ Placeholder | Value | Format or example |
152156
| `{IMAGE}` | The container image you want to use. | `mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice` |
153157
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container. | `4g` |
154158
| `{NUMBER_CPUS}` | The appropriate number of CPUs to allocate for your container. | `4` |
155-
| `{LICENSE_MOUNT}` | The path where the license will be located and mounted. | `/host/license:/path/to/license/directory` |
159+
| `{LICENSE_MOUNT}` | The path where the license is located and mounted. | `/host/license:/path/to/license/directory` |
156160
| `{OUTPUT_PATH}` | The output path for logging [usage records](#usage-records). | `/host/output:/path/to/output/directory` |
157161
| `{CONTAINER_LICENSE_DIRECTORY}` | Location of the license folder on the container's local filesystem. | `/path/to/license/directory` |
158162
| `{CONTAINER_OUTPUT_DIRECTORY}` | Location of the output folder on the container's local filesystem. | `/path/to/output/directory` |
@@ -185,7 +189,7 @@ When operating Docker containers in a disconnected environment, the container wi
185189

186190
#### Arguments for storing logs
187191

188-
When run in a disconnected environment, an output mount must be available to the container to store usage logs. For example, you would include `-v /host/output:{OUTPUT_PATH}` and `Mounts:Output={OUTPUT_PATH}` in the following example, replacing `{OUTPUT_PATH}` with the path where the logs will be stored:
192+
When run in a disconnected environment, an output mount must be available to the container to store usage logs. For example, you would include `-v /host/output:{OUTPUT_PATH}` and `Mounts:Output={OUTPUT_PATH}` in the following example, replacing `{OUTPUT_PATH}` with the path where the logs are stored:
189193

190194
```Docker
191195
docker run -v /host/output:{OUTPUT_PATH} ... <image> ... Mounts:Output={OUTPUT_PATH}
@@ -197,7 +201,7 @@ The container provides two endpoints for returning records about its usage.
197201

198202
#### Get all records
199203

200-
The following endpoint will provide a report summarizing all of the usage collected in the mounted billing record directory.
204+
The following endpoint provides a report summarizing all of the usage collected in the mounted billing record directory.
201205

202206
```http
203207
https://<service>/records/usage-logs/
@@ -207,7 +211,7 @@ https://<service>/records/usage-logs/
207211

208212
`http://localhost:5000/records/usage-logs`
209213

210-
The usage-log endpoint will return a JSON response similar to the following example:
214+
The usage-log endpoint returns a JSON response similar to the following example:
211215

212216
```json
213217
{
@@ -224,13 +228,13 @@ The usage-log endpoint will return a JSON response similar to the following exam
224228

225229
#### Get records for a specific month
226230

227-
The following endpoint will provide a report summarizing usage over a specific month and year.
231+
The following endpoint provides a report summarizing usage over a specific month and year.
228232

229233
```HTTP
230234
https://<service>/records/usage-logs/{MONTH}/{YEAR}
231235
```
232236

233-
This usage-logs endpoint will return a JSON response similar to the following example:
237+
This usage-logs endpoint returns a JSON response similar to the following example:
234238

235239
```json
236240
{
@@ -247,17 +251,17 @@ This usage-logs endpoint will return a JSON response similar to the following ex
247251

248252
### Purchase a different commitment plan for disconnected containers
249253

250-
Commitment plans for disconnected containers have a calendar year commitment period. When you purchase a plan, you'll be charged the full price immediately. During the commitment period, you can't change your commitment plan, however you can purchase more unit(s) at a pro-rated price for the remaining days in the year. You have until midnight (UTC) on the last day of your commitment, to end a commitment plan.
254+
Commitment plans for disconnected containers have a calendar year commitment period. When you purchase a plan, you're charged the full price immediately. During the commitment period, you can't change your commitment plan, however you can purchase more unit(s) at a pro-rated price for the remaining days in the year. You have until midnight (UTC) on the last day of your commitment, to end a commitment plan.
251255

252256
You can choose a different commitment plan in the **Commitment tier pricing** settings of your resource under the **Resource Management** section.
253257

254258
### End a commitment plan
255259

256-
If you decide that you don't want to continue purchasing a commitment plan, you can set your resource's auto-renewal to **Do not auto-renew**. Your commitment plan will expire on the displayed commitment end date. After this date, you won't be charged for the commitment plan. You'll be able to continue using the Azure resource to make API calls, charged at pay-as-you-go pricing. You have until midnight (UTC) on the last day of the year to end a commitment plan for disconnected containers. If you cancel at or before that time, you won't be charged for the following year.
260+
If you decide that you don't want to continue purchasing a commitment plan, you can set your resource's auto-renewal to **Do not auto-renew**. Your commitment plan expires on the displayed commitment end date. After this date, you won't be charged for the commitment plan. You can continue using the Azure resource to make API calls, charged at pay-as-you-go pricing. You have until midnight (UTC) on the last day of the year to end a commitment plan for disconnected containers. If you cancel at or before that time, there are no charges for the next year.
257261

258262
## Troubleshooting
259263

260-
Run the container with an output mount and logging enabled. These settings will enable the container generates log files that are helpful for troubleshooting issues that occur while starting or running the container.
264+
Run the container with an output mount and logging enabled. These settings enable the container generates log files that are helpful for troubleshooting issues that occur while starting or running the container.
261265

262266
> [!TIP]
263267
> For more troubleshooting information and guidance, see [Disconnected containers Frequently asked questions (FAQ)](../../../cognitive-services/containers/disconnected-container-faq.yml).

0 commit comments

Comments
 (0)