You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/containers/form-recognizer-disconnected-containers.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Azure Cognitive Services Form Recognizer containers allow you to use Form Recogn
27
27
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:
28
28
29
29
* Host computer requirements and recommendations.
30
-
* The Docker `pull` command you'll use to download the container.
30
+
* The Docker `pull` command to download the container.
31
31
* How to validate that a container is running.
32
32
* How to send queries to the container's endpoint, once it's running.
## Configure the container to be run in a disconnected environment
95
95
96
-
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:
97
97
98
-
***`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.
99
99
100
100
> [!IMPORTANT]
101
101
>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.
102
102
103
-
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.
104
104
105
105
| Placeholder | Value | Format or example |
106
106
|-------------|-------|---|
107
107
|`{IMAGE}`| The container image you want to use. |`mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice`|
108
-
|`{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`|
109
109
|`{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`|
110
110
|`{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}`|
111
111
|`{CONTAINER_LICENSE_DIRECTORY}`| Location of the license folder on the container's local filesystem. |`/path/to/license/directory`|
@@ -156,7 +156,7 @@ Placeholder | Value | Format or example |
156
156
|`{IMAGE}`| The container image you want to use. |`mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice`|
157
157
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container. | `4g` |
158
158
|`{NUMBER_CPUS}`| The appropriate number of CPUs to allocate for your container. |`4`|
159
-
|`{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`|
160
160
|`{OUTPUT_PATH}`| The output path for logging [usage records](#usage-records). |`/host/output:/path/to/output/directory`|
161
161
|`{CONTAINER_LICENSE_DIRECTORY}`| Location of the license folder on the container's local filesystem. |`/path/to/license/directory`|
162
162
|`{CONTAINER_OUTPUT_DIRECTORY}`| Location of the output folder on the container's local filesystem. |`/path/to/output/directory`|
@@ -189,7 +189,7 @@ When operating Docker containers in a disconnected environment, the container wi
189
189
190
190
#### Arguments for storing logs
191
191
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 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:
193
193
194
194
```Docker
195
195
docker run -v /host/output:{OUTPUT_PATH} ... <image> ... Mounts:Output={OUTPUT_PATH}
@@ -201,7 +201,7 @@ The container provides two endpoints for returning records about its usage.
201
201
202
202
#### Get all records
203
203
204
-
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.
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:
238
238
239
239
```json
240
240
{
@@ -251,17 +251,17 @@ This usage-logs endpoint will return a JSON response similar to the following ex
251
251
252
252
### Purchase a different commitment plan for disconnected containers
253
253
254
-
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.
255
255
256
256
You can choose a different commitment plan in the **Commitment tier pricing** settings of your resource under the **Resource Management** section.
257
257
258
258
### End a commitment plan
259
259
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 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.
261
261
262
262
## Troubleshooting
263
263
264
-
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.
265
265
266
266
> [!TIP]
267
267
> For more troubleshooting information and guidance, see [Disconnected containers Frequently asked questions (FAQ)](../../../cognitive-services/containers/disconnected-container-faq.yml).
0 commit comments