Skip to content

Commit f28ea14

Browse files
authored
Merge pull request #270549 from laujan/236793-how-to-sdk-updates
236793 how to sdk updates
2 parents 806bbe7 + 09f97de commit f28ea14

31 files changed

+3935
-348
lines changed

articles/ai-services/document-intelligence/choose-model-feature.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ ms.author: lajanuar
2626
::: moniker-end
2727

2828
::: moniker range="doc-intel-3.0.0"
29-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
29+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3030
::: moniker-end
3131

3232
Azure AI Document Intelligence supports a wide variety of models that enable you to add intelligent document processing to your applications and optimize your workflows. Selecting the right model is essential to ensure the success of your enterprise. In this article, we explore the available Document Intelligence models and provide guidance for how to choose the best solution for your projects.

articles/ai-services/document-intelligence/concept-custom-label-tips.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ monikerRange: '>=doc-intel-3.0.0'
2626
::: moniker-end
2727

2828
::: moniker range="doc-intel-3.0.0"
29-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
29+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3030
::: moniker-end
3131

3232
This article highlights the best methods for labeling custom model datasets in the Document Intelligence Studio. Labeling documents can be time consuming when you have a large number of labels, long documents, or documents with varying structure. These tips should help you label documents more efficiently.

articles/ai-services/document-intelligence/concept-custom-neural.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ monikerRange: '>=doc-intel-3.0.0'
2828
::: moniker-end
2929

3030
::: moniker range="doc-intel-3.0.0"
31-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
31+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3232
::: moniker-end
3333

3434
Custom neural document models or neural models are a deep learned model type that combines layout and language features to accurately extract labeled fields from documents. The base custom neural model is trained on various document types that makes it suitable to be trained for extracting fields from structured, semi-structured, and unstructured documents. Custom neural models are available in the [v3.0 and later models](v3-1-migration-guide.md) The table below lists common document types for each category:

articles/ai-services/document-intelligence/concept-document-intelligence-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ monikerRange: '>=doc-intel-3.0.0'
2727
::: moniker-end
2828

2929
::: moniker range="doc-intel-3.0.0"
30-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
30+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3131
::: moniker-end
3232

3333
[Document Intelligence Studio](https://documentintelligence.ai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Document Intelligence service into your applications. Use the Document Intelligence Studio to:

articles/ai-services/document-intelligence/concept-general-document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ ms.author: lajanuar
3232
::: moniker-end
3333

3434
::: moniker range="doc-intel-3.0.0"
35-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
35+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3636
::: moniker-end
3737

3838
The General document model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to extract key-value pairs, tables, and selection marks from documents. General document is available with the v3.1 and v3.0 APIs. For more information, _see_ our [migration guide](v3-1-migration-guide.md).

articles/ai-services/document-intelligence/concept-health-insurance-card.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ monikerRange: 'doc-intel-4.0.0 || >=doc-intel-3.0.0'
2727
::: moniker-end
2828

2929
::: moniker range="doc-intel-3.0.0"
30-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
30+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3131
::: moniker-end
3232

3333
The Document Intelligence health insurance card model combines powerful Optical Character Recognition (OCR) capabilities with deep learning models to analyze and extract key information from US health insurance cards. A health insurance card is a key document for care processing and can be digitally analyzed for patient onboarding, financial coverage information, cashless payments, and insurance claim processing. The health insurance card model analyzes health card images; extracts key information such as insurer, member, prescription, and group number; and returns a structured JSON representation. Health insurance cards can be presented in various formats and quality including phone-captured images, scanned documents, and digital PDFs.

articles/ai-services/document-intelligence/concept-read.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ ms.author: lajanuar
2626
::: moniker-end
2727

2828
::: moniker range="doc-intel-3.0.0"
29-
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1 (preview)**](?view=doc-intel-3.1.0&preserve-view=true)
29+
**This content applies to:** ![checkmark](media/yes-icon.png) **v3.0 (GA)** | **Latest versions:** ![purple-checkmark](media/purple-yes-icon.png) [**v4.0 (preview)**](?view=doc-intel-4.0.0&preserve-view=true) ![purple-checkmark](media/purple-yes-icon.png) [**v3.1**](?view=doc-intel-3.1.0&preserve-view=true)
3030
::: moniker-end
3131

3232
> [!NOTE]
Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ manager: nitinme
66
ms.service: azure-ai-document-intelligence
77
ms.custom: linux-related-content
88
ms.topic: include
9-
ms.date: 08/21/2023
9+
ms.date: 03/28/2024
1010
ms.author: lajanuar
1111
---
1212

@@ -19,7 +19,7 @@ To interact with the Document Intelligence service, you need to create an instan
1919

2020
> [!IMPORTANT]
2121
>
22-
> Don't include your key directly in the code and never post it publicly. For production, use a secure way to store and access your credentials, such as [Azure Key Vault](../../../../../ai-services/use-key-vault.md). For more information, see [Azure AI services security](../../../../../ai-services/security-features.md).
22+
> Don't include your key directly in the code and never post it publicly. For production, use a secure way to store and access your credentials, such as [Azure Key Vault](../../../../ai-services/use-key-vault.md). For more information, see [Azure AI services security](../../../../ai-services/security-features.md).
2323
2424
To set the environment variable for your Document Intelligence resource key, open a console window, and follow the instructions for your operating system and development environment. Replace *\<yourKey>* and *\<yourEndpoint>* with the values from your resource in the Azure portal.
2525

@@ -30,29 +30,26 @@ Environment variables in Windows aren't case-sensitive. They're typically declar
3030
1. Set your key variable:
3131

3232
```console
33-
setx FR_KEY <yourKey>
33+
setx DI_KEY <yourKey>
3434
```
3535

3636
1. Set your endpoint variable
3737

3838
```console
39-
setx FR_ENDPOINT <yourEndpoint>
39+
setx DI_ENDPOINT <yourEndpoint>
4040
```
4141

42-
1. After you set your environment variables, close the Command Prompt window. The values remain modified until you change them again.
42+
1. Close the Command Prompt window after you set your environment variables. The values remain until you change them again.
4343

4444
1. Restart any running programs that read the environment variable. For example, if you're using Visual Studio or Visual Studio Code as your editor, restart before running the sample code.
4545

46-
<!-- > [!div class="nextstepaction"]
47-
> [I &#8203;ran into an issue setting the environment variables.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=windows&Product=FormRecognizer&Page=how-to&Section=environment-variables) -->
48-
4946
Here are a few more helpful commands to use with environment variables:
5047

5148
| Command | Action | Example |
5249
|---------|--------|---------|
53-
| `setx VARIABLE_NAME=` | Delete the environment variable by setting the value to an empty string.| `setx FR_KEY=` |
54-
| `setx VARIABLE_NAME=value` | Set or change the value of an environment variable.| `setx FR_KEY=<yourKey>`|
55-
| `set VARIABLE_NAME` | Display the value of a specific environment variable.| `set FR_KEY` |
50+
| `setx VARIABLE_NAME=` | Delete the environment variable by setting the value to an empty string.| `setx DI_KEY=` |
51+
| `setx VARIABLE_NAME=value` | Set or change the value of an environment variable.| `setx DI_KEY=<yourKey>`|
52+
| `set VARIABLE_NAME` | Display the value of a specific environment variable.| `set DI_KEY` |
5653
| `set`| Display all environment variables.| `set`|
5754

5855
#### [macOS](#tab/macOS)
@@ -78,29 +75,26 @@ To set an environment variable permanently, place an export command in your Bash
7875
1. Use a text editor to open the *~/.bash_profile* file and add the following command to create a permanent environment variable:
7976

8077
```bash
81-
export FR_KEY=<yourKey> FR_ENDPOINT=<yourEndpoint>
78+
export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
8279
```
8380

84-
Example: `export FR_KEY="<yourKey>"`
81+
Example: `export DI_KEY="<yourKey>"`
8582

86-
1. Save your changes to the *.bash_profile* file.
83+
1. Save your changes to the *bash_profile* file.
8784

88-
1. Run the following command from your terminal window to make the changes effective:
85+
1. To make the changes effective, run the following command from your terminal window:
8986

9087
```bash
9188
source ~/.bash-profile
9289
```
9390

94-
<!-- > [!div class="nextstepaction"]
95-
> [I &#8203;ran into an issue setting the environment variables.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=macos&Product=FormRecognizer&Page=how-to&Section=environment-variables) -->
96-
9791
Here are a few more helpful commands to use with environment variables:
9892

9993
| Command | Action | Example |
10094
|---------|--------|---------|
101-
| `unset VARIABLE_NAME` | Delete an environment variable.| `unset FR_KEY` |
102-
| `export VARIABLE_NAME=value` | Set or change the value of a temporary environment variable.| `export FR_KEY=<yourKey>` |
103-
| `printenv VARIABLE_NAME`</br>`echo $VARIABLE_NAME`| Display the value of a specific environment variable. With the `echo` command, precede the variable with `$`.| `printenv FR_KEY` </br>`echo $FR_KEY`|
95+
| `unset VARIABLE_NAME` | Delete an environment variable.| `unset DI_KEY` |
96+
| `export VARIABLE_NAME=value` | Set or change the value of a temporary environment variable.| `export DI_KEY=<yourKey>` |
97+
| `printenv VARIABLE_NAME`</br>`echo $VARIABLE_NAME`| Display the value of a specific environment variable. With the `echo` command, precede the variable with `$`.| `printenv DI_KEY` </br>`echo $DI_KEY`|
10498
| `printenv` | Display all environment variables.| `printenv` |
10599

106100
#### [Linux](#tab/linux)
@@ -112,13 +106,13 @@ The `export` command sets the variable and exports it to the global environment,
112106
1. Set your key variable:
113107

114108
```bash
115-
export FR_KEY=<yourKey>
109+
export DI_KEY=<yourKey>
116110
```
117111

118112
1. Set your endpoint variable:
119113

120114
```bash
121-
export FR_ENDPOINT=<yourEndpoint>
115+
export DI_ENDPOINT=<yourEndpoint>
122116
```
123117

124118
To set an environment variable permanently, place an export command in your Bash `~/.bashrc` startup script:
@@ -129,26 +123,23 @@ To set an environment variable permanently, place an export command in your Bash
129123
export <VARIABLE>=<value>
130124
```
131125

132-
Example: `export FR_KEY=<yourKey>`
126+
Example: `export DI_KEY=<yourKey>`
133127

134128
1. Save your changes to the *.bashrc* file.
135129

136-
1. Run the following command from your terminal window to make the changes effective:
130+
1. To make the changes effective, run the following command from your terminal window:
137131

138132
```bash
139133
source ~/.bashrc
140134
```
141135

142-
<!-- > [!div class="nextstepaction"]
143-
> [I &#8203;ran into an issue setting the environment variables.](https://microsoft.qualtrics.com/jfe/form/SV_0Cl5zkG3CnDjq6O?PLanguage=linux&Product=FormRecognizer&Page=how-to&Section=environment-variables) -->
144-
145136
Here are a few more helpful commands to use with environment variables:
146137

147138
| Command | Action | Example |
148139
|---------|--------|---------|
149-
| `unset VARIABLE_NAME`| Delete an environment variable.|`unset FR_KEY=` |
150-
| `export VARIABLE_NAME=value` | Set or change the value of a temporary environment variable.| `export FR_KEY={yourKey}`|
151-
| `printenv VARIABLE_NAME`</br>`echo $VARIABLE_NAME`| Display the value of an environment variable. With the `echo` command, precede the variable with `$`.| `printenv FR_KEY` </br>`echo $FR_KEY`|
140+
| `unset VARIABLE_NAME`| Delete an environment variable.|`unset DI_KEY=` |
141+
| `export VARIABLE_NAME=value` | Set or change the value of a temporary environment variable.| `export DI_KEY={yourKey}`|
142+
| `printenv VARIABLE_NAME`</br>`echo $VARIABLE_NAME`| Display the value of an environment variable. With the `echo` command, precede the variable with `$`.| `printenv DI_KEY` </br>`echo $DI_KEY`|
152143
| `printenv`| Display all environment variables.|`printenv`|
153144

154145
---

0 commit comments

Comments
 (0)