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/cognitive-services/form-recognizer/form-recognizer-container-configuration.md
+23-25Lines changed: 23 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,36 +12,32 @@ ms.author: dapine
12
12
---
13
13
# Configure Form Recognizer containers
14
14
15
-
Form Recognizer containers enable customers to build an application architecture that is optimized to take advantage of both robust cloud capabilities and edge locality.
15
+
By using Azure Form Recognizer containers, you can build an application architecture that's optimized to take advantage of both robust cloud capabilities and edge locality.
16
16
17
-
The **Form Recognizer** container runtime environment is configured using the `docker run` command arguments. This container has several required settings, along with a few optional settings. Several [examples](#example-docker-run-commands)of the command are available. The container-specific settings are the billing settings.
17
+
You configure the Form Recognizer container run-time environment by using the `docker run` command arguments. This container has several required settings and a few optional settings. For a few examples, see the ["Example docker run commands"](#example-docker-run-commands)section. The container-specific settings are the billing settings.
> The [`ApiKey`](#apikey-configuration-setting), [`Billing`](#billing-configuration-setting), and [`Eula`](#eula-setting) settings are used together, and you must provide valid values for all three of them; otherwise your container won't start. For more information about using these configuration settings to instantiate a container, see [Billing](form-recognizer-container-howto.md#billing).
24
+
> The [`ApiKey`](#apikey-configuration-setting), [`Billing`](#billing-configuration-setting), and [`Eula`](#eula-setting) settings are used together. You must provide valid values for all three settings; otherwise, your container won't start. For more information about using these configuration settings to instantiate a container, see [Billing](form-recognizer-container-howto.md#billing).
25
25
26
26
## ApiKey configuration setting
27
27
28
-
The `ApiKey` setting specifies the Azure resource key used to track billing information for the container. You must specify a value for the ApiKey and the value must be a valid key for the _Form Recognizer_ resource specified for the [`Billing`](#billing-configuration-setting)configuration setting.
28
+
The `ApiKey` setting specifies the Azure resource key that's used to track billing information for the container. The value for the ApiKey must be a valid key for the _Form Recognizer_ resource that's specified for `Billing` in the "Billing configuration setting" section.
29
29
30
-
This setting can be found in the following place:
31
-
32
-
* Azure portal: **Form Recognizer's** Resource Management, under **Keys**
30
+
You can find this setting in the Azure portal, in **Form Recognizer Resource Management**, under **Keys**.
The `Billing` setting specifies the endpoint URI of the _Form Recognizer_ resource on Azure used to meter billing information for the container. You must specify a value for this configuration setting, and the value must be a valid endpoint URI for a _Form Recognizer_ resource on Azure. The container reports usage about every 10 to 15 minutes.
41
-
42
-
This setting can be found in the following place:
38
+
The `Billing` setting specifies the endpoint URI of the _Form Recognizer_ resource on Azure that's used to meter billing information for the container. The value for this configuration setting must be a valid endpoint URI for a _Form Recognizer_ resource on Azure. The container reports usage about every 10 to 15 minutes.
@@ -66,11 +62,11 @@ This setting can be found in the following place:
66
62
67
63
## Mount settings
68
64
69
-
Use bind mounts to read and write data to and from the container. You can specify an input mount or output mount by specifying the `--mount` option in the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command.
65
+
Use bind mounts to read and write data to and from the container. You can specify an input mount or an output mount by specifying the `--mount` option in the [`docker run` command](https://docs.docker.com/engine/reference/commandline/run/).
70
66
71
-
The Form Recognizer container requires an input and output mount. The input mount can be read-only and is required to access the data that will be used for training and scoring. The output mount has to be writable and will be used to store the models and temporary data.
67
+
The Form Recognizer container requires an input mount and an output mount. The input mount can be read-only, and it's required for access to the data that's used for training and scoring. The output mount has to be writable, and you use it to store the models and temporary data.
72
68
73
-
The exact syntax of the host mount location varies depending on the host operating system. Additionally, the [host computer](form-recognizer-container-howto.md#the-host-computer)'s mount location may not be accessible due to a conflict between permissions used by the Docker service account and the host mount location permissions.
69
+
The exact syntax of the host mount location varies depending on the host operating system. Additionally, the mount location of the [host computer](form-recognizer-container-howto.md#the-host-computer) might not be accessible because of a conflict between the Docker service account permissions and the host mount location permissions.
74
70
75
71
|Optional| Name | Data type | Description |
76
72
|-------|------|-----------|-------------|
@@ -79,22 +75,24 @@ The exact syntax of the host mount location varies depending on the host operati
79
75
80
76
## Example docker run commands
81
77
82
-
The following examples use the configuration settings to illustrate how to write and use `docker run` commands. Once running, the container continues to run until you [stop](form-recognizer-container-howto.md#stop-the-container) it.
78
+
The following examples use the configuration settings to illustrate how to write and use `docker run` commands. When it's running, the container continues to run until you [stop it](form-recognizer-container-howto.md#stop-the-container).
83
79
84
-
***Line-continuation character**: The Docker commands in the following sections use the back slash, `\`, as a line continuation character. Replace or remove this based on your host operating system's requirements.
85
-
***Argument order**: Do not change the order of the arguments unless you are very familiar with Docker containers.
80
+
***Line-continuation character**: The Docker commands in the following sections use a back slash (\\) as a line continuation character. Replace or remove this character, depending on your host operating system's requirements.
81
+
***Argument order**: Don't change the order of the arguments unless you're familiar with Docker containers.
86
82
87
-
Replace {_argument_name_} with your own values:
83
+
Replace {_argument_name_} in the following table with your own values:
88
84
89
85
| Placeholder | Value |
90
86
|-------------|-------|
91
-
|{BILLING_KEY} |This key is used to start the container, and is available on the Azure portal's Form Recognizer Keys page. |
92
-
|{BILLING_ENDPOINT_URI} | The billing endpoint URI value is available on the Azure portal's Form Recognizer Overview page.|
93
-
|{COMPUTER_VISION_API_KEY}| The key is available on the Azure portal's Computer Vision API Keys page.|
94
-
|{COMPUTER_VISION_ENDPOINT_URI}|The billing endpoint. If you are using a cloud-based Computer Vision resource, the URI value is available on the Azure portal's Computer Vision API Overview page. If you are using a `cognitive-services-recognize-text` container, use the billing endpoint URL passed to the container in the `docker run` command.|
87
+
|{BILLING_KEY} |The key that's used to start the container. It's available on the Azure portal Form Recognizer Keys page. |
88
+
|{BILLING_ENDPOINT_URI} | The billing endpoint URI value is available on the Azure portal Form Recognizer Overview page.|
89
+
|{COMPUTER_VISION_API_KEY}| The key is available on the Azure portal Computer Vision API Keys page.|
90
+
|{COMPUTER_VISION_ENDPOINT_URI}|The billing endpoint. If you're using a cloud-based Computer Vision resource, the URI value is available on the Azure portal Computer Vision API Overview page. If you're using a *cognitive-services-recognize-text* container, use the billing endpoint URL that's passed to the container in the `docker run` command.|
95
91
96
92
> [!IMPORTANT]
97
-
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](#billing-configuration-setting).
93
+
> To run the container, specify the `Eula`, `Billing`, and `ApiKey` options; otherwise, the container won't start. For more information, see [Billing](#billing-configuration-setting).
94
+
95
+
> [!NOTE]
98
96
> The ApiKey value is the **Key** from the Azure Form Recognizer Resource keys page.
0 commit comments