Skip to content

Commit 2e4f9c8

Browse files
authored
Merge pull request #88943 from IEvangelist/gatheringParams
[CogSvcs] Added required parameter gathering details
2 parents d261768 + 6e50a25 commit 2e4f9c8

14 files changed

+99
-96
lines changed

articles/cognitive-services/Anomaly-Detector/anomaly-detector-container-configuration.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: conceptual
11-
ms.date: 06/19/2019
11+
ms.date: 09/18/2019
1212
ms.author: dapine
1313
---
1414

@@ -99,8 +99,10 @@ Replace value in brackets, `{}`, with your own values:
9999

100100
| Placeholder | Value | Format or example |
101101
|-------------|-------|---|
102-
|{API_KEY} | The endpoint key of the Anomaly Detector resource. |xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx|
103-
|{ENDPOINT_URI} | The billing endpoint value including region.|`https://westus2.api.cognitive.microsoft.com`|
102+
| **{API_KEY}** | The endpoint key of the `Anomaly Detector` resource on the Azure `Anomaly Detector` Keys page. | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |
103+
| **{ENDPOINT_URI}** | The billing endpoint value is available on the Azure `Anomaly Detector` Overview page.| See [gathering required parameters](anomaly-detector-container-howto.md#gathering-required-parameters) for explicit examples. |
104+
105+
[!INCLUDE [subdomains-note](../../../includes/cognitive-services-custom-subdomains-note.md)]
104106

105107
> [!IMPORTANT]
106108
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](anomaly-detector-container-howto.md#billing).

articles/cognitive-services/Anomaly-Detector/anomaly-detector-container-howto.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: anomaly-detector
1010
ms.topic: conceptual
11-
ms.date: 06/19/2019
11+
ms.date: 09/18/2019
1212
ms.author: dapine
1313
---
1414

@@ -35,6 +35,8 @@ You must meet the following prerequisites before using Anomaly Detector containe
3535
|Familiarity with Docker | You should have a basic understanding of Docker concepts, like registries, repositories, containers, and container images, as well as knowledge of basic `docker` commands.|
3636
|Anomaly Detector resource |In order to use these containers, you must have:<br><br>An Azure _Anomaly Detector_ resource to get the associated API key and endpoint URI. Both values are available on the Azure portal's **Anomaly Detector** Overview and Keys pages and are required to start the container.<br><br>**{API_KEY}**: One of the two available resource keys on the **Keys** page<br><br>**{ENDPOINT_URI}**: The endpoint as provided on the **Overview** page|
3737

38+
[!INCLUDE [Gathering required container parameters](../containers/includes/container-gathering-required-parameters.md)]
39+
3840
## Request access to the container registry
3941

4042
You must first complete and submit the [Anomaly Detector Container Request form](https://aka.ms/adcontainer) to request access to the container.
@@ -75,7 +77,6 @@ For a full description of available tags, such as `latest` used in the preceding
7577
-->
7678
[!INCLUDE [Tip for using docker list](../../../includes/cognitive-services-containers-docker-list-tip.md)]
7779

78-
7980
### Docker pull for the Anomaly Detector container
8081

8182
```Docker
@@ -91,14 +92,9 @@ Once the container is on the [host computer](#the-host-computer), use the follow
9192

9293
## Run the container with `docker run`
9394

94-
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run any of the three containers. The command uses the following parameters:
95-
96-
| Placeholder | Value |
97-
|-------------|-------|
98-
|{API_KEY} | This key is used to start the container, and is available on the Azure portal's Anomaly Detector Keys page. |
99-
|{ENDPOINT_URI} | The billing endpoint URI value is available on the Azure portal's Anomaly Detector Overview page.|
95+
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. Refer to [gathering required parameters](#gathering-required-parameters) for details on how to get the `{ENDPOINT_URI}` and `{API_KEY}` values.
10096

101-
Replace these parameters with your own values in the following example `docker run` command.
97+
[Examples](anomaly-detector-container-configuration.md#example-docker-run-commands) of the `docker run` command are available.
10298

10399
```bash
104100
docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 \

articles/cognitive-services/Computer-vision/computer-vision-how-to-install-containers.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: computer-vision
1010
ms.topic: conceptual
11-
ms.date: 06/19/2019
11+
ms.date: 09/18/2019
1212
ms.author: dapine
1313
ms.custom: seodec18
1414
---
@@ -32,6 +32,8 @@ You must meet the following prerequisites before using Recognize Text containers
3232
|Familiarity with Docker | You should have a basic understanding of Docker concepts, like registries, repositories, containers, and container images, as well as knowledge of basic `docker` commands.|
3333
|Computer Vision resource |In order to use the container, you must have:<br><br>An Azure **Computer Vision** resource and the associated API key the endpoint URI. Both values are available on the Overview and Keys pages for the resource and are required to start the container.<br><br>**{API_KEY}**: One of the two available resource keys on the **Keys** page<br><br>**{ENDPOINT_URI}**: The endpoint as provided on the **Overview** page|
3434

35+
[!INCLUDE [Gathering required container parameters](../containers/includes/container-gathering-required-parameters.md)]
36+
3537
## Request access to the private container registry
3638

3739
[!INCLUDE [Request access to public preview](../../../includes/cognitive-services-containers-request-access.md)]
@@ -72,16 +74,9 @@ Once the container is on the [host computer](#the-host-computer), use the follow
7274

7375
## Run the container with `docker run`
7476

75-
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. The command uses the following parameters:
76-
77-
| Placeholder | Value |
78-
|-------------|-------|
79-
|{API_KEY} | This key is used to start the container, and is available on the Azure `Cognitive Services` Keys page. |
80-
|{ENDPOINT_URI} | The billing endpoint URI value. Example is: `https://westus.api.cognitive.microsoft.com/vision/v2.0`|
81-
82-
You need to add the `vision/v2.0` routing to the endpoint URI as shown in the following BILLING_ENDPOINT_URI example.
77+
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. Refer to [gathering required parameters](#gathering-required-parameters) for details on how to get the `{ENDPOINT_URI}` and `{API_KEY}` values.
8378

84-
Replace these parameters with your own values in the following example `docker run` command.
79+
[Examples](computer-vision-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
8580

8681
```bash
8782
docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 \

articles/cognitive-services/Computer-vision/computer-vision-resource-container-config.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: nitinme
88
ms.service: cognitive-services
99
ms.subservice: computer-vision
1010
ms.topic: conceptual
11-
ms.date: 06/19/2019
11+
ms.date: 09/18/2019
1212
ms.author: dapine
1313
ms.custom: seodec18
1414
---
@@ -92,8 +92,10 @@ Replace {_argument_name_} with your own values:
9292

9393
| Placeholder | Value | Format or example |
9494
|-------------|-------|---|
95-
|{API_KEY} | The endpoint key of the Cognitive Services resource. |xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx|
96-
|{ENDPOINT_URI} | The billing endpoint value including region.|`https://westcentralus.api.cognitive.microsoft.com/vision/v1.0`|
95+
| **{API_KEY}** | The endpoint key of the `Computer Vision` resource on the Azure `Computer Vision` Keys page. | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |
96+
| **{ENDPOINT_URI}** | The billing endpoint value is available on the Azure `Computer Vision` Overview page.| See [gathering required parameters](computer-vision-how-to-install-containers.md#gathering-required-parameters) for explicit examples. |
97+
98+
[!INCLUDE [subdomains-note](../../../includes/cognitive-services-custom-subdomains-note.md)]
9799

98100
> [!IMPORTANT]
99101
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](computer-vision-how-to-install-containers.md#billing).

articles/cognitive-services/Face/face-how-to-install-containers.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: face-api
1111
ms.topic: conceptual
12-
ms.date: 06/19/2019
12+
ms.date: 09/18/2019
1313
ms.author: dapine
1414
---
1515

@@ -29,6 +29,8 @@ You must meet the following prerequisites before you use the Face API containers
2929
|Familiarity with Docker | You need a basic understanding of Docker concepts, such as registries, repositories, containers, and container images. You also need knowledge of basic `docker` commands.|
3030
|Face resource |To use the container, you must have:<br><br>An Azure **Face** resource and the associated API key and the endpoint URI. Both values are available on the **Overview** and **Keys** pages for the resource. They're required to start the container.<br><br>**{API_KEY}**: One of the two available resource keys on the **Keys** page<br><br>**{ENDPOINT_URI}**: The endpoint as provided on the **Overview** page
3131

32+
[!INCLUDE [Gathering required container parameters](../containers/includes/container-gathering-required-parameters.md)]
33+
3234
## Request access to the private container registry
3335

3436
[!INCLUDE [Request access to private container registry](../../../includes/cognitive-services-containers-request-access.md)]
@@ -75,16 +77,9 @@ After the container is on the [host computer](#the-host-computer), use the follo
7577

7678
## Run the container with docker run
7779

78-
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run any of the three containers. The command uses the following parameters.
79-
80-
| Placeholder | Value |
81-
|-------------|-------|
82-
|{API_KEY} | This key is used to start the container and is available on the Azure `Cognitive Services` **Keys** page. |
83-
|{ENDPOINT_URI} | The billing endpoint URI value is available on the Azure `Cognitive Services` **Overview** page. An example is `https://westus.api.cognitive.microsoft.com/face/v1.0`.|
84-
85-
Add the `face/v1.0` routing to the endpoint URI, as shown in the preceding ENDPOINT_URI example.
80+
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. Refer to [gathering required parameters](#gathering-required-parameters) for details on how to get the `{ENDPOINT_URI}` and `{API_KEY}` values.
8681

87-
Replace these parameters with your own values in the following `docker run` command example:
82+
[Examples](face-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
8883

8984
```bash
9085
docker run --rm -it -p 5000:5000 --memory 4g --cpus 1 \

articles/cognitive-services/Face/face-resource-container-config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: face-api
1111
ms.topic: conceptual
12-
ms.date: 09/06/2019
12+
ms.date: 09/18/2019
1313
ms.author: dapine
1414
---
1515

@@ -133,8 +133,8 @@ Replace {_argument_name_} with your own values:
133133

134134
| Placeholder | Value | Format or example |
135135
|-------------|-------|---|
136-
|{API_KEY} | The endpoint key of the Cognitive Services resource. |xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx|
137-
|{ENDPOINT_URI} | The endpoint URL value.|`https://myresourcename.cognitive.microsoft.com/face/v1.0`|
136+
| **{API_KEY}** | The endpoint key of the `Face` resource on the Azure `Face` Keys page. | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |
137+
| **{ENDPOINT_URI}** | The billing endpoint value is available on the Azure `Face` Overview page.| See [gathering required parameters](face-how-to-install-containers.md#gathering-required-parameters) for explicit examples. |
138138

139139
[!INCLUDE [subdomains-note](../../../includes/cognitive-services-custom-subdomains-note.md)]
140140

articles/cognitive-services/LUIS/luis-container-configuration.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Docker container settings - LUIS
33
titleSuffix: Azure Cognitive Services
4-
description: The LUIS container runtime environment is configured using the `docker run` command arguments. LUIS has several required settings, along with a few optional settings.
4+
description: The LUIS container runtime environment is configured using the `docker run` command arguments. LUIS has several required settings, along with a few optional settings.
55
services: cognitive-services
66
author: IEvangelist
77
manager: nitinme
88
ms.custom: seodec18
99
ms.service: cognitive-services
1010
ms.subservice: language-understanding
11-
ms.topic: conceptual
12-
ms.date: 06/11/2019
11+
ms.topic: conceptual
12+
ms.date: 09/18/2019
1313
ms.author: dapine
1414
---
1515

@@ -101,7 +101,7 @@ The following table describes the settings supported.
101101

102102
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](luis-container-howto.md#stop-the-container) it.
103103

104-
* These examples use the directory off the `c:` drive to avoid any permission conflicts on Windows. If you need to use a specific directory as the input directory, you may need to grant the docker service permission.
104+
* These examples use the directory off the `C:` drive to avoid any permission conflicts on Windows. If you need to use a specific directory as the input directory, you may need to grant the docker service permission.
105105
* Do not change the order of the arguments unless you are very familiar with docker containers.
106106
* If you are using a different operating system, use the correct console/terminal, folder syntax for mounts, and line continuation character for your system. These examples assume a Windows console with a line continuation character `^`. Because the container is a Linux operating system, the target mount uses a Linux-style folder syntax.
107107

@@ -111,11 +111,13 @@ Replace {_argument_name_} with your own values:
111111

112112
| Placeholder | Value | Format or example |
113113
|-------------|-------|---|
114-
|{API_KEY} | The endpoint key of the trained LUIS application. |xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx|
115-
|{ENDPOINT_URL} | The billing endpoint value is available on the Azure `Cognitive Services` Overview page. |https://westus.api.cognitive.microsoft.com/luis/v2.0|
114+
| **{API_KEY}** | The endpoint key of the `LUIS` resource on the Azure `LUIS` Keys page. | `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` |
115+
| **{ENDPOINT_URI}** | The billing endpoint value is available on the Azure `LUIS` Overview page.| See [gathering required parameters](luis-container-howto.md#gathering-required-parameters) for explicit examples. |
116+
117+
[!INCLUDE [subdomains-note](../../../includes/cognitive-services-custom-subdomains-note.md)]
116118

117119
> [!IMPORTANT]
118-
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](luis-container-howto.md#billing).
120+
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](luis-container-howto.md#billing).
119121
> The ApiKey value is the **Key** from the Keys and Endpoints page in the LUIS portal and is also available on the Azure `Cognitive Services` resource keys page.
120122
121123
### Basic example

0 commit comments

Comments
 (0)