Skip to content

Commit 86f2a33

Browse files
authored
update for 4.0
1 parent 2189650 commit 86f2a33

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

articles/ai-services/document-intelligence/containers/install-run.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,36 @@ ms.author: lajanuar
1111
---
1212

1313

14+
1415
# Install and run containers
1516

1617
<!-- markdownlint-disable MD024 -->
1718
<!-- markdownlint-disable MD051 -->
1819

1920
:::moniker range=">=doc-intel-2.1.0"
2021

21-
**This content applies to:** ![checkmark](../media/yes-icon.png) **v3.0 (GA)** ![checkmark](../media/yes-icon.png) **v3.1 (GA)**
22+
**This content applies to:** ![checkmark](../media/yes-icon.png) **v3.0 (GA)** ![checkmark](../media/yes-icon.png) **v3.1 (GA)** ![checkmark](../media/yes-icon.png) **v4.0 (GA)**
2223

2324
Azure AI Document Intelligence is an Azure AI service that lets you build automated data processing software using machine-learning technology. Document Intelligence enables you to identify and extract text, key/value pairs, selection marks, table data, and more from your documents. The results are delivered as structured data that ../includes the relationships in the original file. Containers process only the data provided to them and solely utilize the resources they're permitted to access. Containers can't process data from other regions.
2425

2526
In this article you can learn how to download, install, and run Document Intelligence containers. Containers enable you to run the Document Intelligence service in your own environment. Containers are great for specific security and data governance requirements.
2627

28+
* **Layout** model is supported by Document Intelligence v3.1 containers.
29+
2730
* **Read**, **Layout**, **ID Document**, **Receipt**, and **Invoice** models are supported by Document Intelligence v3.1 containers.
2831

2932
* **Read**, **Layout**, **General Document**, **Business Card**, and **Custom** models are supported by Document Intelligence v3.0 containers.
3033

3134
## Version support
3235

33-
Support for containers is currently available with Document Intelligence version `v3.0: 2022-08-31 (GA)` for all models and `v3.1 2023-07-31 (GA)` for Read, Layout, ID Document, Receipt, and Invoice models:
36+
Support for containers is currently available with Document Intelligence version `v3.0: 2022-08-31 (GA)` for all models, `v3.1 2023-07-31 (GA)` for Read, Layout, ID Document, Receipt, and Invoice models, and `v4.0 2024-11-30 (GA)` for Layout:
3437

3538
* [REST API `v3.0: 2022-08-31 (GA)`](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP)
3639
* [REST API `v3.1: 2023-07-31 (GA)`](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.1%20(2023-07-31)&tabs=HTTP&preserve-view=true)
40+
* [REST API `v4.0: 2024-11-30 (GA)`](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v4.0%20(2024-11-30)&tabs=HTTP&preserve-view=true)
3741
* [Client libraries targeting `REST API v3.0: 2022-08-31 (GA)`](../sdk-overview-v3-0.md)
3842
* [Client libraries targeting `REST API v3.1: 2023-07-31 (GA)`](../sdk-overview-v3-1.md)
43+
* [Client libraries targeting `REST API v4.0: 2024-11-30 (GA)`](../sdk-overview-v4-0.md)
3944

4045
## Prerequisites
4146

@@ -113,6 +118,54 @@ Feature container | Supporting containers |
113118
> IMAGE ID REPOSITORY TAG
114119
> <image-id> <repository-path/name> <tag-name>
115120
> ```
121+
::: moniker-end
122+
123+
:::moniker range="doc-intel-4.0.0"
124+
## Run the container with the **docker-compose up** command
125+
126+
* Replace the {ENDPOINT_URI} and {API_KEY} values with your resource Endpoint URI and the key from the Azure resource page.
127+
128+
:::image type="content" source="../media/containers/keys-and-endpoint.png" alt-text="Screenshot of Azure portal keys and endpoint page.":::
129+
130+
* Ensure that the `EULA` value is set to *accept*.
131+
132+
* The `EULA`, `Billing`, and `ApiKey` values must be specified; otherwise the container can't start.
133+
134+
> [!IMPORTANT]
135+
> The keys are used to access your Document Intelligence resource. Do not share your keys. Store them securely, for example, using Azure Key Vault. We also recommend regenerating these keys regularly. Only one key is necessary to make an API call. When regenerating the first key, you can use the second key for continued access to the service.
136+
137+
### [Layout](#tab/layout)
138+
139+
The following code sample is a self-contained `docker compose` example to run the Document Intelligence Layout container. With `docker compose`, you use a YAML file to configure your application's services. Then, with `docker-compose up` command, you create and start all the services from your configuration. Enter {FORM_RECOGNIZER_ENDPOINT_URI} and {FORM_RECOGNIZER_KEY} values for your Layout container instance.
140+
141+
```yml
142+
version: "3.9"
143+
services:
144+
azure-form-recognizer-layout:
145+
container_name: azure-form-recognizer-layout
146+
image: mcr.microsoft.com/azure-cognitive-services/form-recognizer/layout-4.0
147+
environment:
148+
- EULA=accept
149+
- billing={FORM_RECOGNIZER_ENDPOINT_URI}
150+
- apiKey={FORM_RECOGNIZER_KEY}
151+
ports:
152+
- "5000:5000"
153+
networks:
154+
- ocrvnet
155+
networks:
156+
ocrvnet:
157+
driver: bridge
158+
```
159+
160+
Now, you can start the service with the [**docker compose**](https://docs.docker.com/compose/) command:
161+
162+
```bash
163+
docker-compose up
164+
```
165+
::: moniker-end
166+
167+
168+
:::moniker range="doc-intel-3.0.0 || doc-intel-3.1.0"
116169

117170
## Run the container with the **docker-compose up** command
118171

0 commit comments

Comments
 (0)