Skip to content

Commit d33289c

Browse files
authored
Merge pull request #6112 from laujan/6067-bug-fix-acrolinx
6067 bug fix acrolinx
2 parents b384b7c + 9660d15 commit d33289c

File tree

12 files changed

+119
-144
lines changed

12 files changed

+119
-144
lines changed

articles/ai-services/document-intelligence/index.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ metadata:
1010
ms.topic: landing-page
1111
author: laujan
1212
ms.author: lajanuar
13-
ms.date: 11/19/2024
13+
ms.date: 07/17/2025
1414
monikerRange: '<=doc-intel-4.0.0'
1515
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
1616
# Limits: https://learn.learn.microsoft.com/help/contribute/contribute-how-to-write-landing-page?branch=main#limits
@@ -87,10 +87,6 @@ landingContent:
8787
links:
8888
- text: Transparency notes
8989
url: /azure/ai-foundry/responsible-ai/document-intelligence/transparency-note?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
90-
- text: Characteristics and limitations
91-
url: /azure/ai-foundry/responsible-ai/document-intelligence/characteristics-and-limitations?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
92-
- text: Guidance for integration and responsible use
93-
url: /azure/ai-foundry/responsible-ai/document-intelligence/guidance-integration-responsible-use?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json
9490
- text: Data privacy, compliance, and security
9591
url: /azure/ai-foundry/responsible-ai/document-intelligence/data-privacy-security?toc=/azure/ai-services/document-intelligence/toc.json&bc=/azure/ai-services/document-intelligence/breadcrumb/toc.json#Card 5
9692

articles/ai-services/document-intelligence/quickstarts/includes/rest-api.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: include
9-
ms.date: 04/11/2025
9+
ms.date: 07/17/2025
1010
ms.author: lajanuar
1111
---
1212

@@ -30,10 +30,7 @@ In this quickstart, learn to use the Document Intelligence REST API to analyze a
3030

3131
* Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services)
3232

33-
* curl command line tool installed.
34-
35-
* [Windows](https://curl.haxx.se/windows/)
36-
* [Mac or Linux](https://learn2torials.com/thread/how-to-install-curl-on-mac-or-linux-(ubuntu)-or-windows)
33+
* cURL command-line tool installed.
3734

3835
* **PowerShell version 7.*+** (or a similar command-line application.):
3936
* [Windows](/powershell/scripting/install/installing-powershell-on-windows)

articles/ai-services/language-service/conversational-language-understanding/how-to/use-containers.md

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@ description: Use Docker containers for the conversational language understanding
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-language
8-
ms.custom:
9-
- ignite-2024
108
ms.topic: how-to
11-
ms.date: 04/29/2025
9+
ms.date: 07/17/2025
1210
ms.author: lajanuar
13-
keywords: on-premises, Docker, container
1411
---
1512

1613
# Install and run Conversational Language Understanding (CLU) containers
@@ -26,7 +23,7 @@ If you don't have an Azure subscription, create a [free account](https://azure.m
2623

2724
You must meet the following prerequisites before using CLU containers.
2825

29-
* If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/cognitive-services/).
26+
* An active Azure subscription. If you don't have one, create a [free account](https://azure.microsoft.com/free/cognitive-services/).
3027
* [Docker](https://docs.docker.com/) installed on a host computer. Docker must be configured to allow the containers to connect with and send billing data to Azure.
3128
* On Windows, Docker must also be configured to support Linux containers.
3229
* You should have a basic understanding of [Docker concepts](https://docs.docker.com/get-started/overview/).
@@ -40,17 +37,17 @@ You must meet the following prerequisites before using CLU containers.
4037

4138
The following table describes the minimum and recommended specifications for the available container. Each CPU core must be at least 2.6 gigahertz (GHz) or faster.
4239

43-
It's recommended to have a CPU with AVX-512 instruction set, for the best experience (performance and accuracy).
40+
We recommended that you have a CPU with AVX-512 instruction set, for the best experience (performance and accuracy).
4441

4542
| | Minimum host specs | Recommended host specs |
4643
|---------------------|------------------------|------------------------|
47-
| **CLU** | 1 core, 2 GB memory | 4 cores, 8 GB memory |
44+
| **CLU** | `1 core`, `2-GB memory` | `4 cores`, `8-GB memory` |
4845

4946
CPU core and memory correspond to the `--cpus` and `--memory` settings, which are used as part of the `docker run` command.
5047

5148
## Export your Conversational Language Understanding model
5249

53-
Before you proceed with running the docker image, you need to export your own trained model to expose it to your container. Use the following command to extract your model and replace the placeholders below with your own values:
50+
Before you proceed with running the docker image, you need to export your own trained model to expose it to your container. Use the following command to extract your model and replace the placeholders with your own values:
5451

5552
|Placeholder |Value|Format or example|
5653
|------------|-----|-----------------|
@@ -75,7 +72,7 @@ The CLU container image can be found on the `mcr.microsoft.com` container regist
7572

7673
To use the latest version of the container, you can use the `latest` tag, which is for English. You can also find a full list of containers for supported languages using the [tags on the MCR](https://mcr.microsoft.com/product/azure-cognitive-services/language/clu/tags).
7774

78-
The latest CLU container is available in several languages. To download the container for the English container, use the command below.
75+
The latest CLU container is available in several languages. To download the container for the English container, use the following command:
7976

8077
```
8178
docker pull mcr.microsoft.com/azure-cognitive-services/language/clu:latest
@@ -85,14 +82,14 @@ docker pull mcr.microsoft.com/azure-cognitive-services/language/clu:latest
8582

8683
## Run the container in download model mode
8784

88-
After creating the exported model in the section above, users have to run the container in order to download the deployment package that was created specifically for their exported models.
85+
After the exported model is created, users have to run the container to download the deployment package that was created specifically for their exported models.
8986

90-
| Placeholder| Value|Format or example |
87+
| Placeholder| Value | Format or example |
9188
|---|---|---|
92-
| **{API_KEY}**| The key for your Language resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | 
93-
| **{ENDPOINT_URI}** | The endpoint for accessing the API. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
94-
| **{IMAGE_TAG}** | The image tag representing the language of the container you want to run. Make sure this matches the `docker pull` command you used.  | latest|
95-
| **{LOCAL_CLU_PORT}**| Port number assigned for the container in local machine.| 5000 |
89+
| **{API_KEY}**| The key for your Language resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | See Azure portal |
90+
| **{ENDPOINT_URI}** | The endpoint for accessing the API. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
91+
| **{IMAGE_TAG}**| The image tag representing the language of the container you want to run. Make sure the tag matches the `docker pull` command you used.  | latest|
92+
| **{LOCAL_CLU_PORT}** | Port number assigned for the container in local machine.| 5000 |
9693
| **{LOCAL_MODEL_DIRECTORY}** | Absolute directory in host machine where exported models are saved in. | `C:\usr\local\myDeploymentPackage` |
9794
| **{PROJECT_NAME}**| Name of the project that the exported model belongs to | myProject |
9895
| **{EXPORTED_MODEL_NAME}** | Exported model to be downloaded | myExportedModel |
@@ -110,26 +107,26 @@ exportedModelName={EXPORTED_MODEL_NAME}
110107

111108
DO NOT alter the downloaded files. Even altering the name or folder structure can affect the integrity of the container and might break it.
112109

113-
Repeat those steps to download as many models as you'd like to test. They can belong to different projects and have different exported model names.
110+
Repeat those steps to download as many models as you'd like to test. Your models can belong to different projects and have different (exported) model names.
114111

115112
## Run the container with `docker run`
116113

117-
Once the container is on the host computer, use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the containers. The container continues to run until you stop it. Replace the placeholders below with your own values:
114+
Once the container is on the host computer, use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the containers. The container continues to run until you stop it. Replace the placeholders with your own values:
118115

119116

120117
> [!IMPORTANT]
121-
> * 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.
122-
> * 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).
118+
> * The docker commands in the following sections use the back slash, `\`, as a line continuation character. Replace or remove the back slash based on your host operating system's requirements.
119+
> * The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container doesn't start. For more information, see [Billing](#billing).
123120
124-
To run the CLU container, execute the following `docker run` command. Replace the placeholders below with your own values:
121+
To run the CLU container, execute the following `docker run` command. Replace the placeholders with your own values:
125122

126123
| Placeholder | Value | Format or example |
127124
|-------------|-------|---|
128125
| **{API_KEY}** | The key for your Language resource. You can find it on your resource's **Key and endpoint** page, on the Azure portal. |`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`|
129126
| **{ENDPOINT_URI}** | The endpoint for accessing the API. You can find it on your resource's **Key and endpoint** page, on the Azure portal. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
130-
| **{IMAGE_TAG}** | The image tag representing the language of the container you want to run. Make sure this matches the `docker pull` command you used. | `latest` |
127+
| **{IMAGE_TAG}** | The image tag representing the language of the container you want to run. Make sure the tag matches the `docker pull` command you used. | `latest` |
131128
|**{LOCAL_CLU_PORT}** |Port number assigned for the container in local machine. |5000 |
132-
|**{LOCAL_NER_PORT}** |Port number of the NER container. See Run NER Container section below. |5001 (Has to be different that the above port number) |
129+
|**{LOCAL_NER_PORT}** |Port number of the `NER` container. See Run `NER` Container section. |5001 (Has to be different than the port number) |
133130
|**{LOCAL_LOGGING_DIRECTORY}** |Absolute directory in host machine where that logs are saved in. |`C:\usr\local\mylogs` |
134131
|**{LOCAL_MODEL_DIRECTORY}** |Absolute directory in host machine where exported models are saved in. |`C:\usr\local\myDeploymentPackage` |
135132

@@ -145,13 +142,13 @@ This command:
145142

146143
* Runs a *CLU* container from the container image
147144
* Allocates one CPU core and 8 gigabytes (GB) of memory
148-
* Exposes TCP port 5000 and allocates a pseudo-TTY for the container
145+
* Exposes `TCP` port 5000 and allocates a pseudo-TTY for the container
149146
* Automatically removes the container after it exits. The container image is still available on the host computer.
150147

151148
[!INCLUDE [Running multiple containers on the same host](../../../includes/cognitive-services-containers-run-multiple-same-host.md)]
152149

153-
## Running NER Container
154-
CLU relies on NER to handle prebuilt entities. The CLU container works properly without NER if users decide not to integrate it. NER billing is disabled when it's used through CLU, no extra charges are generated unless a call is made directly to NER's container.
150+
## Running named entity recognition (NER) Container
151+
CLU relies on NER to handle prebuilt entities. The CLU container works properly without NER if users decide not to integrate it. NER billing is turned off when accessed via CLU, so there are no added charges unless you make a direct call to the NER container.
155152

156153
To set up NER in CLU container
157154
- Follow the [NER container documentation](../../named-entity-recognition/how-to/use-containers.md).
@@ -179,7 +176,7 @@ For information on how to call CLU see [our guide](call-api.md).
179176

180177
## Troubleshooting
181178

182-
If you run the container with an output [mount](../../concepts/configure-containers.md#mount-settings) and logging enabled, the container generates log files that are helpful to troubleshoot issues that happen while starting or running the container.
179+
If you run the container with both an output [mount](../../concepts/configure-containers.md#mount-settings) and logging enabled, the container generates log files. The log files can help you troubleshoot any issues that occur during startup or while the container is running.
183180

184181
[!INCLUDE [Azure AI services FAQ note](../../../containers/includes/cognitive-services-faq-note.md)]
185182

@@ -201,7 +198,7 @@ In this article, you learned concepts and workflow for downloading, installing,
201198
* You must specify billing information when instantiating a container.
202199

203200
> [!IMPORTANT]
204-
> Azure AI containers aren't licensed to run without being connected to Azure for metering. Customers need to enable the containers to communicate billing information with the metering service at all times. Azure AI containers don't send customer data (for example, text that is being analyzed) to Microsoft.
201+
> Azure AI containers aren't licensed to run without being connected to Azure for metering. Customers must enable containers to always communicate billing information to the metering service. Azure AI containers don't send customer data (for example, text that is being analyzed) to Microsoft.
205202
206203
## Next steps
207204

0 commit comments

Comments
 (0)