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
@@ -23,7 +27,7 @@ Azure Cognitive Services Form Recognizer containers allow you to use Form Recogn
23
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:
24
28
25
29
* 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.
27
31
* How to validate that a container is running.
28
32
* How to send queries to the container's endpoint, once it's running.
## Configure the container to be run in a disconnected environment
91
95
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:
93
97
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.
95
99
96
100
> [!IMPORTANT]
97
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.
98
102
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.
100
104
101
105
| Placeholder | Value | Format or example |
102
106
|-------------|-------|---|
103
107
|`{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`|
105
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`|
106
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}`|
107
111
|`{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 |
152
156
|`{IMAGE}`| The container image you want to use. |`mcr.microsoft.com/azure-cognitive-services/form-recognizer/invoice`|
153
157
`{MEMORY_SIZE}` | The appropriate size of memory to allocate for your container. | `4g` |
154
158
|`{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`|
156
160
|`{OUTPUT_PATH}`| The output path for logging [usage records](#usage-records). |`/host/output:/path/to/output/directory`|
157
161
|`{CONTAINER_LICENSE_DIRECTORY}`| Location of the license folder on the container's local filesystem. |`/path/to/license/directory`|
158
162
|`{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
185
189
186
190
#### Arguments for storing logs
187
191
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:
189
193
190
194
```Docker
191
195
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.
197
201
198
202
#### Get all records
199
203
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.
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:
234
238
235
239
```json
236
240
{
@@ -247,17 +251,17 @@ This usage-logs endpoint will return a JSON response similar to the following ex
247
251
248
252
### Purchase a different commitment plan for disconnected containers
249
253
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.
251
255
252
256
You can choose a different commitment plan in the **Commitment tier pricing** settings of your resource under the **Resource Management** section.
253
257
254
258
### End a commitment plan
255
259
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.
257
261
258
262
## Troubleshooting
259
263
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.
261
265
262
266
> [!TIP]
263
267
> For more troubleshooting information and guidance, see [Disconnected containers Frequently asked questions (FAQ)](../../../cognitive-services/containers/disconnected-container-faq.yml).
0 commit comments