Skip to content

Commit 0ae425d

Browse files
committed
ready for main merge
1 parent aecf143 commit 0ae425d

15 files changed

+135
-82
lines changed

articles/ai-services/.openpublishing.redirection.ai-services.json

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@
502502
},
503503
{
504504
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-overview-v2-1.md",
505-
"redirect_url": "/azure/ai-services/document-intelligence/v21/sdk-overview",
505+
"redirect_url": "/azure/ai-services/document-intelligence/v21/sdk-overview-v2-1",
506506
"redirect_document_id": true
507507
},
508508
{
@@ -714,6 +714,56 @@
714714
"source_path_from_root": "/articles/ai-services/document-intelligence/language-support-custom.md",
715715
"redirect_url": "/azure/ai-services/document-intelligence/language-support/custom",
716716
"redirect_document_id": true
717+
},
718+
{
719+
"source_path_from_root": "/articles/ai-services/document-intelligence/encrypt-data-at-rest.md",
720+
"redirect_url": "/azure/ai-services/document-intelligence/authentication/encrypt-data-at-rest",
721+
"redirect_document_id": true
722+
},
723+
{
724+
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-overview-v3-0.md",
725+
"redirect_url": "/azure/ai-services/document-intelligence/versioning/sdk-overview-v3-0",
726+
"redirect_document_id": true
727+
},
728+
{
729+
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-overview-v3-1.md",
730+
"redirect_url": "/azure/ai-services/document-intelligence/versioning/sdk-overview-v3-1",
731+
"redirect_document_id": true
732+
},
733+
{
734+
"source_path_from_root": "/articles/ai-services/document-intelligence/sdk-overview-v4-0.md",
735+
"redirect_url": "/azure/ai-services/document-intelligence/versioning/sdk-overview-v4-0",
736+
"redirect_document_id": true
737+
},
738+
{
739+
"source_path_from_root": "/articles/ai-services/document-intelligence/v3-1-migration-guide.md",
740+
"redirect_url": "/azure/ai-services/document-intelligence/versioning/v3-1-migration-guide",
741+
"redirect_document_id": true
742+
},
743+
{
744+
"source_path_from_root": "/articles/ai-services/document-intelligence/v3-error-guide.md",
745+
"redirect_url": "/azure/ai-services/document-intelligence/how-to-guides/resolve-errors",
746+
"redirect_document_id": true
747+
},
748+
{
749+
"source_path_from_root": "/articles/ai-services/document-intelligence/changelog-release-history.md",
750+
"redirect_url": "/azure/ai-services/document-intelligence/versioning/changelog-release-history",
751+
"redirect_document_id": true
752+
},
753+
{
754+
"source_path_from_root": "/articles/ai-services/document-intelligence/tutorial-azure-function.md",
755+
"redirect_url": "/azure/ai-services/document-intelligence/tutorial/azure-function",
756+
"redirect_document_id": true
757+
},
758+
{
759+
"source_path_from_root": "/articles/ai-services/document-intelligence/tutorial-logic-apps.md",
760+
"redirect_url": "/azure/ai-services/document-intelligence/tutorial/logic-apps",
761+
"redirect_document_id": true
762+
},
763+
{
764+
"source_path_from_root": "/articles/ai-services/document-intelligence/disaster-recovery.md",
765+
"redirect_url": "/azure/ai-services/document-intelligence/how-to-guides/disaster-recovery",
766+
"redirect_document_id": true
717767
}
718768

719769
]

articles/ai-services/document-intelligence/encrypt-data-at-rest.md renamed to articles/ai-services/document-intelligence/authentication/encrypt-data-at-rest.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@ manager: venkyv
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
99
ms.date: 11/15/2023
10-
ms.author: egeaney
1110
monikerRange: '<=doc-intel-4.0.0'
1211
---
1312

1413

1514
# Document Intelligence encryption of data at rest
1615

17-
[!INCLUDE [applies to v4.0, v3.1, v3.0, and v2.1](includes/applies-to-v40-v31-v30-v21.md)]
16+
[!INCLUDE [applies to v4.0, v3.1, v3.0, and v2.1](../includes/applies-to-v40-v31-v30-v21.md)]
1817

1918
> [!IMPORTANT]
2019
>
@@ -24,12 +23,12 @@ monikerRange: '<=doc-intel-4.0.0'
2423
2524
Azure AI Document Intelligence automatically encrypts your data when persisting it to the cloud. Document Intelligence encryption protects your data to help you to meet your organizational security and compliance commitments.
2625

27-
[!INCLUDE [cognitive-services-about-encryption](../../ai-services/includes/cognitive-services-about-encryption.md)]
26+
[!INCLUDE [cognitive-services-about-encryption](../../../ai-services/includes/cognitive-services-about-encryption.md)]
2827

2928
> [!IMPORTANT]
3029
> Customer-managed keys are only available resources created after 11 May, 2020. To use CMK with Document Intelligence, you will need to create a new Document Intelligence resource. Once the resource is created, you can use Azure Key Vault to set up your managed identity.
3130
32-
[!INCLUDE [cognitive-services-cmk](../../ai-services/includes/configure-customer-managed-keys.md)]
31+
[!INCLUDE [cognitive-services-cmk](../../../ai-services/includes/configure-customer-managed-keys.md)]
3332

3433
## Next steps
3534

articles/ai-services/document-intelligence/disaster-recovery.md renamed to articles/ai-services/document-intelligence/how-to-guides/disaster-recovery.md

Lines changed: 6 additions & 6 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: how-to
9-
ms.date: 08/07/2024
9+
ms.date: 10/15/2024
1010
ms.author: lajanuar
1111
---
1212

@@ -16,19 +16,19 @@ ms.author: lajanuar
1616
# Disaster recovery
1717

1818
::: moniker range="doc-intel-4.0.0"
19-
[!INCLUDE [applies to v4.0](includes/applies-to-v40.md)]
19+
[!INCLUDE [applies to v4.0](../includes/applies-to-v40.md)]
2020
::: moniker-end
2121

2222
::: moniker range="doc-intel-3.1.0"
23-
[!INCLUDE [applies to v3.1](includes/applies-to-v31.md)]
23+
[!INCLUDE [applies to v3.1](../includes/applies-to-v31.md)]
2424
::: moniker-end
2525

2626
::: moniker range="doc-intel-3.0.0"
27-
[!INCLUDE [applies to v3.0](includes/applies-to-v30.md)]
27+
[!INCLUDE [applies to v3.0](../includes/applies-to-v30.md)]
2828
::: moniker-end
2929

3030
::: moniker range="doc-intel-2.1.0"
31-
[!INCLUDE [applies to v2.1](includes/applies-to-v21.md)]
31+
[!INCLUDE [applies to v2.1](../includes/applies-to-v21.md)]
3232
::: moniker-end
3333

3434
::: moniker range=">= doc-intel-2.1.0"
@@ -38,7 +38,7 @@ When you create a Document Intelligence resource in the Azure portal, you specif
3838
The Copy API enables this scenario by allowing you to copy custom models and classifiers from one Document Intelligence account or into others, which can exist in any supported geographical region. This guide shows you how to use the Copy REST API with cURL for custom models. You can also use an HTTP request service to issue the requests.
3939

4040
> [!NOTE]
41-
> Starting with the `2024-07-31-preview` API, custom clasification models also support the Copy API. This guide specifically uses custom models to copy models. For classifier model copy, follow this [guide](train/custom-classifier.md#copy-a-model).
41+
> Starting with the `2024-07-31-preview` API, custom clasification models also support the Copy API. This guide specifically uses custom models to copy models. For classifier model copy, follow this [guide](../train/custom-classifier.md#copy-a-model).
4242
4343
## Business scenarios
4444

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ items:
119119
href: concept/incremental-classifier.md
120120
- name: 🆕Custom generative model
121121
displayName: ai studio, neural, template, custom
122-
href: train/custom-generative-extraction.md
122+
href: train/custom-generative-extraction.md
123123
- name: Custom template model
124124
displayName: structure, selection, labels, tables, tabular, train, template, neural, build mode, signatures, custom
125125
href: train/custom-template.md
@@ -240,7 +240,7 @@ items:
240240
href: authentication/managed-identities-secured-access.md
241241
- name: Use customer-managed keys
242242
displayName: encrypt, encryption, key vault
243-
href: encrypt-data-at-rest.md
243+
href: authentication/encrypt-data-at-rest.md
244244
- name: Use Microsoft Entra authentication
245245
displayName: headers, subscription, access token, azure active directory, subdomain, role, service principal
246246
href: ../../ai-services/authentication.md?context=/azure/ai-services/document-intelligence/context/context
@@ -307,7 +307,7 @@ items:
307307
- name: 2022-08-31 (v3.0)
308308
href: /rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v3.0%20(2022-08-31)&preserve-view=true&tabs=HTTP
309309
- name: Error codes v4.0, v3.1, and v3.0
310-
href: v3-error-guide.md
310+
href: how-to-guides/resolve-errors.md
311311
- name: v2.1
312312
href: /rest/api/aiservices/analyzer?view=rest-aiservices-v2.1&preserve-view=true
313313
- name: Client libraries (2024-07-31-preview)
@@ -320,6 +320,10 @@ items:
320320
href: /javascript/api/overview/azure/ai-document-intelligence-rest-readme?view=azure-node-preview&preserve-view=true
321321
- name: Python
322322
href: /python/api/overview/azure/ai-documentintelligence-readme?view=azure-python-preview&preserve-view=true
323+
- name: Schema
324+
items:
325+
- name: Marriage certificate
326+
href: https://github.com/Azure-Samples/document-intelligence-code-samples/blob/main/schema/marriage-certificate/2024-07-31-preview.json?context=/azure/ai-services/context/context
323327
- name: Resources
324328
items:
325329
- name: Enterprise readiness

articles/ai-services/document-intelligence/tutorial-azure-function.md renamed to articles/ai-services/document-intelligence/tutorial/azure-function.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.custom: VS Code-azure-extension-update-completed, devx-track-python
1717

1818
Document Intelligence can be used as part of an automated data processing pipeline built with Azure Functions. This guide will show you how to use Azure Functions to process documents that are uploaded to an Azure blob storage container. This workflow extracts table data from stored documents using the Document Intelligence layout model and saves the table data in a .csv file in Azure. You can then display the data using Microsoft Power BI (not covered here).
1919

20-
:::image type="content" source="media/tutorial-azure-function/workflow-diagram.png" alt-text="Screenshot of Azure Service workflow diagram":::
20+
:::image type="content" source="../media/tutorial-azure-function/workflow-diagram.png" alt-text="Screenshot of Azure Service workflow diagram":::
2121

2222
In this tutorial, you learn how to:
2323

@@ -36,7 +36,7 @@ In this tutorial, you learn how to:
3636

3737
* After your resource deploys, select **Go to resource**. You need the key and endpoint from the resource you create to connect your application to the Document Intelligence API. You'll paste your key and endpoint into the code below later in the tutorial:
3838

39-
:::image type="content" source="media/containers/keys-and-endpoint.png" alt-text="Screenshot of keys and endpoint location in the Azure portal.":::
39+
:::image type="content" source="../media/containers/keys-and-endpoint.png" alt-text="Screenshot of keys and endpoint location in the Azure portal.":::
4040

4141
* [**Python 3.6.x, 3.7.x, 3.8.x or 3.9.x**](https://www.python.org/downloads/) (Python 3.10.x isn't supported for this project).
4242

@@ -75,11 +75,11 @@ In this tutorial, you learn how to:
7575

7676
* Select the Azure subscription that you're using for this project and below you should see the Azure Function App.
7777

78-
:::image type="content" source="media/tutorial-azure-function/azure-extensions-visual-studio-code.png" alt-text="Screenshot of a list showing your Azure resources in a single, unified view.":::
78+
:::image type="content" source="../media/tutorial-azure-function/azure-extensions-visual-studio-code.png" alt-text="Screenshot of a list showing your Azure resources in a single, unified view.":::
7979

8080
1. Select the Workspace (Local) section located below your listed resources. Select the plus symbol and choose the **Create Function** button.
8181

82-
:::image type="content" source="media/tutorial-azure-function/workspace-create-function.png" alt-text="Screenshot showing where to begin creating an Azure function.":::
82+
:::image type="content" source="../media/tutorial-azure-function/workspace-create-function.png" alt-text="Screenshot showing where to begin creating an Azure function.":::
8383

8484
1. When prompted, choose **Create new project** and navigate to the **function-app** directory. Choose **Select**.
8585

@@ -119,13 +119,13 @@ In this tutorial, you learn how to:
119119

120120
1. Open Azure Storage Explorer and upload the sample PDF document to the **input** container. Then check the VS Code terminal. The script should log that it was triggered by the PDF upload.
121121

122-
:::image type="content" source="media/tutorial-azure-function/visual-studio-code-terminal-test.png" alt-text="Screenshot of the VS Code terminal after uploading a new document.":::
122+
:::image type="content" source="../media/tutorial-azure-function/visual-studio-code-terminal-test.png" alt-text="Screenshot of the VS Code terminal after uploading a new document.":::
123123

124124
1. Stop the script before continuing.
125125

126126
## Add document processing code
127127

128-
Next, you'll add your own code to the Python script to call the Document Intelligence service and parse the uploaded documents using the Document Intelligence [layout model](prebuilt/layout.md).
128+
Next, you'll add your own code to the Python script to call the Document Intelligence service and parse the uploaded documents using the Document Intelligence [layout model](../prebuilt/layout.md).
129129

130130
1. In VS Code, navigate to the function's *requirements.txt* file. This file defines the dependencies for your script. Add the following Python packages to the file:
131131

@@ -184,7 +184,7 @@ Next, you'll add your own code to the Python script to call the Document Intelli
184184
```
185185
186186
> [!IMPORTANT]
187-
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use a secure way of storing and accessing your credentials like [Azure Key Vault](/azure/key-vault/general/overview). For more information, *see* Azure AI services [security](../../ai-services/security-features.md).
187+
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use a secure way of storing and accessing your credentials like [Azure Key Vault](/azure/key-vault/general/overview). For more information, *see* Azure AI services [security](../../../ai-services/security-features.md).
188188
189189
1. Next, add code to query the service and get the returned data.
190190
@@ -297,5 +297,5 @@ In this tutorial, you learned how to use an Azure Function written in Python to
297297
> [!div class="nextstepaction"]
298298
> [Microsoft Power BI](https://powerbi.microsoft.com/integrations/azure-table-storage/)
299299
300-
* [What is Document Intelligence?](overview.md)
301-
* Learn more about the [layout model](prebuilt/layout.md)
300+
* [What is Document Intelligence?](../overview.md)
301+
* Learn more about the [layout model](../prebuilt/layout.md)

articles/ai-services/document-intelligence/tutorial-logic-apps.md renamed to articles/ai-services/document-intelligence/tutorial/logic-apps.md

Lines changed: 13 additions & 13 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: tutorial
9-
ms.date: 04/24/2024
9+
ms.date: 10/15/2024
1010
ms.author: lajanuar
1111
zone_pivot_groups: cloud-location
1212
monikerRange: '<=doc-intel-4.0.0'
@@ -20,12 +20,12 @@ monikerRange: '<=doc-intel-4.0.0'
2020
<!-- markdownlint-disable MD004 -->
2121
<!-- markdownlint-disable MD032 -->
2222
:::moniker range=">=doc-intel-3.0.0"
23-
[!INCLUDE [applies to v4.0, v3.1 and v3.0](includes/applies-to-v40-v31-v30.md)]
23+
[!INCLUDE [applies to v4.0, v3.1 and v3.0](../includes/applies-to-v40-v31-v30.md)]
2424

2525
:::moniker-end
2626

2727
:::moniker range="doc-intel-2.1.0"
28-
[!INCLUDE [applies to v2.1](includes/applies-to-v21.md)]
28+
[!INCLUDE [applies to v2.1](../includes/applies-to-v21.md)]
2929
:::moniker-end
3030

3131
:::moniker range=">=doc-intel-3.0.0"
@@ -63,11 +63,11 @@ For more information, *see* [Logic Apps Overview](/azure/logic-apps/logic-apps-o
6363
Choose a workflow using a file from either your Microsoft OneDrive account or Microsoft ShareDrive site:
6464

6565
:::zone pivot="workflow-onedrive"
66-
[!INCLUDE [OneDrive](includes/logic-app-tutorial/onedrive.md)]
66+
[!INCLUDE [OneDrive](../includes/logic-app-tutorial/onedrive.md)]
6767
:::zone-end
6868

6969
:::zone pivot="workflow-sharepoint"
70-
[!INCLUDE [SharePoint](includes/logic-app-tutorial/sharepoint.md)]
70+
[!INCLUDE [SharePoint](../includes/logic-app-tutorial/sharepoint.md)]
7171
:::zone-end
7272

7373
## Test the automation flow
@@ -86,35 +86,35 @@ Now that we created the flow, the last thing to do is to test it and make sure t
8686

8787
1. Return to the Logic App designer tab and select the **Run trigger** button and select **Run** from the drop-down menu.
8888

89-
:::image type="content" source="media/logic-apps-tutorial/trigger-run.png" alt-text="Screenshot of Run trigger and Run buttons.":::
89+
:::image type="content" source="../media/logic-apps-tutorial/trigger-run.png" alt-text="Screenshot of Run trigger and Run buttons.":::
9090

9191
1. You see a message in the upper=right corner indicating that the trigger was successful:
9292

93-
:::image type="content" source="media/logic-apps-tutorial/trigger-successful.png" alt-text="Screenshot of Successful trigger message.":::
93+
:::image type="content" source="../media/logic-apps-tutorial/trigger-successful.png" alt-text="Screenshot of Successful trigger message.":::
9494

9595
1. Navigate to your Logic App overview page by selecting your app name link in the upper-left corner.
9696

97-
:::image type="content" source="media/logic-apps-tutorial/navigate-overview.png" alt-text="Screenshot of navigate to overview page link.":::
97+
:::image type="content" source="../media/logic-apps-tutorial/navigate-overview.png" alt-text="Screenshot of navigate to overview page link.":::
9898

9999
1. Check the status, to see if the run succeeded or failed. You can select the status indicator to check which steps were successful.
100100

101-
:::image border="true" type="content" source="media/logic-apps-tutorial/succeeded-failed-indicator.png" alt-text="Screenshot of Succeeded or Failed status.":::
101+
:::image border="true" type="content" source="../media/logic-apps-tutorial/succeeded-failed-indicator.png" alt-text="Screenshot of Succeeded or Failed status.":::
102102

103103
1. If your run failed, check the failed step to ensure that you entered the correct information.
104104

105-
:::image type="content" source="media/logic-apps-tutorial/failed-run-step.png" alt-text="Screenshot of failed step.":::
105+
:::image type="content" source="../media/logic-apps-tutorial/failed-run-step.png" alt-text="Screenshot of failed step.":::
106106

107107
1. After a workflow run succeeds, check your email. There's a new email with the information we specified.
108108

109-
:::image type="content" source="media/logic-apps-tutorial/invoice-received.png" alt-text="Screenshot of received email message.":::
109+
:::image type="content" source="../media/logic-apps-tutorial/invoice-received.png" alt-text="Screenshot of received email message.":::
110110

111111
1. After you're done, [disable or delete your logic app](/azure/logic-apps/manage-logic-apps-with-azure-portal?tabs=consumption#disable-enable-logic-apps) so that usage stops.
112112

113-
:::image type="content" source="media/logic-apps-tutorial/disable-delete.png" alt-text="Screenshot of disable and delete buttons.":::
113+
:::image type="content" source="../media/logic-apps-tutorial/disable-delete.png" alt-text="Screenshot of disable and delete buttons.":::
114114

115115
Congratulations! You completed this tutorial.
116116

117117
## Next steps
118118

119119
> [!div class="nextstepaction"]
120-
> [Learn more about Document Intelligence models](model-overview.md)
120+
> [Learn more about Document Intelligence models](../model-overview.md)
File renamed without changes.

articles/ai-services/document-intelligence/changelog-release-history.md renamed to articles/ai-services/document-intelligence/versioning/changelog-release-history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ms.author: lajanuar
1919

2020
This reference article provides a version-based description of Document Intelligence feature and capability releases, changes, updates, and enhancements.
2121

22-
[!INCLUDE [preview-version-notice](includes/preview-notice.md)]
22+
[!INCLUDE [preview-version-notice](../includes/preview-notice.md)]
2323

2424
#### August 2024 (preview) release
2525

0 commit comments

Comments
 (0)