Merge pull request #259622 from MicrosoftDocs/main

11/28 11:00 AM IST Publishing

Author: Saisang

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

@@ -8,7 +8,7 @@ ms.service: azure-ai-document-intelligence
 ms.custom:
   - ignite-2023
 ms.topic: reference
-ms.date: 11/15/2023
+ms.date: 11/27/2023
 ms.author: lajanuar
 ---
 
@@ -21,13 +21,63 @@ ms.author: lajanuar
 
 This reference article provides a version-based description of Document Intelligence feature and capability releases, changes, updates, and enhancements.
 
+#### November 2023 (preview) release
+
+[!INCLUDE [preview-version-notice](includes/preview-notice.md)]
+
+### [**.NET (C#)**](#tab/csharp)
+
+* Document Intelligence **1.0.0-beta.1**
+* **Targets REST API 2023-10-31-preview by default**
+
+[**Package (NuGet)**](https://www.nuget.org/packages/Azure.AI.DocumentIntelligence/1.0.0-beta.1)
+
+[**ReadMe**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/README.md)
+
+[**Samples**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/documentintelligence/Azure.AI.DocumentIntelligence/samples/README.md)
+
+### [**Java**](#tab/java)
+
+* Document Intelligence **1.0.0-beta.1**
+* **Targets REST API 2023-10-31-preview by default**
+
+[**Package (MVN)**](https://repo1.maven.org/maven2/com/azure/azure-ai-documentintelligence/1.0.0-beta.1/)
+
+[**ReadMe**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/README.md#azure-documentintelligence-client-library-for-java)
+
+[**Samples**](https://github.com/Azure/azure-sdk-for-java/tree/azure-ai-documentintelligence_1.0.0-beta.1/sdk/documentintelligence/azure-ai-documentintelligence/src/samples#examples)
+
+### [**JavaScript**](#tab/javascript)
+
+* Document Intelligence **1.0.0-beta.1**
+* **Targets REST API 2023-10-31-preview by default**
+
+[**Package (npm)**](https://www.npmjs.com/package/@azure-rest/ai-document-intelligence)
+
+[**ReadMe**](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest#readme)
+
+[**Samples**](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/documentintelligence/ai-document-intelligence-rest/samples/v1-beta/typescript)
+
+### [**Python**](#tab/python)
+
+* Document Intelligence **1.0.0b1**
+* **Targets REST API 2023-10-31-preview by default**
+
+[**Package (PyPi)**](https://pypi.org/project/azure-ai-documentintelligence/)
+
+[**ReadMe**](https://github.com/Azure/azure-sdk-for-python/blob/7c42462ac662522a6fd21b17d2a20f4cd40d0356/sdk/documentintelligence/azure-ai-documentintelligence/README.md)
+
+[**Samples**](https://github.com/Azure/azure-sdk-for-python/tree/7c42462ac662522a6fd21b17d2a20f4cd40d0356/sdk/documentintelligence/azure-ai-documentintelligence/samples)
+
+---
+
 #### August 2023 (GA) release
 
 ### [**C#**](#tab/csharp)
 
-* **Version 4.1.0 (2023-08-10)**
-* **Targets API version2023-07-31 by default**
-* **Version 2023-02-28-preview is no longer supported**
+* Form Recognizer **4.1.0 (2023-08-10)**
+* **Targets REST API 2023-07-31 by default**
+* **REST API target 2023-02-28-preview is no longer supported**
 * [**Breaking changes**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md#breaking-changes-1)
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md)
@@ -40,9 +90,9 @@ This reference article provides a version-based description of Document Intellig
 
 ### [**Java**](#tab/java)
 
-* **4.1.0 (2023-08-10)**
-* **Targets API version 2023-07-31 by default**
-* **Version 2023-02-28-preview is no longer supported**
+* Form Recognizer **4.1.0 (2023-08-10)**
+* **Targets REST API 2023-07-31 by default**
+* **REST API target 2023-02-28-preview is no longer supported**
 * [**Breaking changes**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#breaking-changes)
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
@@ -55,9 +105,9 @@ This reference article provides a version-based description of Document Intellig
 
 ### [**JavaScript**](#tab/javascript)
 
-* **Version 5.0.0 (2023-08-08)**
-* **Targets API version 2023-07-31 by default**
-* **Version 2023-02-28-preview is no longer supported**
+* Form Recognizer **5.0.0 (2023-08-08)**
+* **Targets REST API 2023-07-31 by default**
+* **REST API target 2023-02-28-preview is no longer supported**
 * [**Breaking changes**](https://github.com/witemple-msft/azure-sdk-for-js/blob/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md#breaking-changes)
 
 [**Changelog/Release History**](https://github.com/witemple-msft/azure-sdk-for-js/blob/ai-form-recognizer/5.0.0-release/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
@@ -70,9 +120,9 @@ This reference article provides a version-based description of Document Intellig
 
 ### [**Python**](#tab/python)
 
-* **Version 3.3.0 (2023-08-08)**
-* **Targets API version 2023-07-31 by default**
-* **Version 2023-02-28-preview is no longer supported**
+* Form Recognizer **3.3.0 (2023-08-08)**
+* **Targets REST API 2023-07-31 by default**
+* **REST API target 2023-02-28-preview is no longer supported**
 * [**Breaking changes**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#breaking-changes)
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.3.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
@@ -91,7 +141,7 @@ This release includes the following updates:
 
 ### [**C#**](#tab/csharp)
 
-* **Version 4.1.0-beta.1 (2023-04-13**)
+* Form Recognizer **4.1.0-beta.1 (2023-04-13**)
 * **Targets 2023-02-28-preview by default**
 * **No breaking changes**
 
@@ -105,11 +155,10 @@ This release includes the following updates:
 
 ### [**Java**](#tab/java)
 
-* **Version 4.1.0-beta.1 (2023-04-12**)
+* Form Recognizer **4.1.0-beta.1 (2023-04-12**)
 * **Targets 2023-02-28-preview by default**
 * **No breaking changes**
 
-
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.1.0-beta.1/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#410-beta1-2023-04-12)
 
 [**Package (MVN)**](https://mvnrepository.com/artifact/com.azure/azure-ai-formrecognizer/4.1.0-beta.1)
@@ -120,7 +169,7 @@ This release includes the following updates:
 
 ### [**JavaScript**](#tab/javascript)
 
-* **Version 4.1.0-beta.1 (2023-04-11**)
+* Form Recognizer **4.1.0-beta.1 (2023-04-11**)
 * **Targets 2023-02-28-preview by default**
 * **No breaking changes**
 
@@ -134,7 +183,7 @@ This release includes the following updates:
 
 ### [**Python**](#tab/python)
 
-* **Version 3.3.0b1 (2023-04-13**)
+* Form Recognizer **3.3.0b1 (2023-04-13**)
 * **Targets 2023-02-28-preview by default**
 * **No breaking changes**
 
@@ -153,11 +202,11 @@ This release includes the following updates:
 This release includes the following updates:
 
 > [!IMPORTANT]
-> The `DocumentAnalysisClient` and `DocumentModelAdministrationClient` now target API version v3.0 GA, released 2022-08-31. These clients are no longer supported by API versions 2020-06-30-preview or earlier.
+> The `DocumentAnalysisClient` and `DocumentModelAdministrationClient` now target API v3.0 GA, released 2022-08-31. These clients are no longer supported by APIs 2020-06-30-preview or earlier.
 
 ### [**C#**](#tab/csharp)
 
-* **Version 4.0.0 GA (2022-09-08)**
+* Form Recognizer **4.0.0 GA (2022-09-08)**
 * **Supports REST API v3.0 and v2.0 clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md)
@@ -172,7 +221,7 @@ This release includes the following updates:
 
 ### [**Java**](#tab/java)
 
-* **Version 4.0.0 GA (2022-09-08)**
+* Form Recognizer **4.0.0 GA (2022-09-08)**
 * **Supports REST API v3.0 and v2.0 clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
@@ -187,7 +236,7 @@ This release includes the following updates:
 
 ### [**JavaScript**](#tab/javascript)
 
-* **Version 4.0.0 GA (2022-09-08)**
+* Form Recognizer **4.0.0 GA (2022-09-08)**
 * **Supports REST API v3.0 and v2.0 clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
@@ -205,7 +254,7 @@ This release includes the following updates:
 > [!NOTE]
 > Python 3.7 or later is required to use this package.
 
-* **Version 3.2.0 GA (2022-09-08)**
+* Form Recognizer **3.2.0 GA (2022-09-08)**
 * **Supports REST API v3.0 and v2.0 clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
@@ -226,8 +275,8 @@ This release includes the following updates:
 
 ### [**C#**](#tab/csharp)
 
-**Version 4.0.0-beta.5 (2022-08-09)**
-**Supports REST API 2022-06-30-preview clients**
+* Form Recognizer **4.0.0-beta.5 (2022-08-09)**
+* **Supports REST API 2022-06-30-preview clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md#400-beta5-2022-08-09)
 
@@ -237,8 +286,8 @@ This release includes the following updates:
 
 ### [**Java**](#tab/java)
 
-**Version 4.0.0-beta.6 (2022-08-10)**
-**Supports REST API 2022-06-30-preview and earlier clients**
+* Form Recognizer **4.0.0-beta.6 (2022-08-10)**
+* **Supports REST API 2022-06-30-preview and earlier clients**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md#400-beta6-2022-08-10)
 
@@ -248,8 +297,8 @@ This release includes the following updates:
 
 ### [**JavaScript**](#tab/javascript)
 
-**Version 4.0.0-beta.6 (2022-08-09)**
-**Supports REST API 2022-06-30-preview and earlier clients**
+* Form Recognizer **4.0.0-beta.6 (2022-08-09)**
+* **Supports REST API 2022-06-30-preview and earlier clients**
 
  [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0-beta.6/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
 
@@ -262,8 +311,8 @@ This release includes the following updates:
 > [!IMPORTANT]
 > Python 3.6 is no longer supported in this release. Use Python 3.7 or later.
 
-**Version 3.2.0b6 (2022-08-09)**
-**Supports REST API 2022-06-30-preview and earlier clients**
+* Form Recognizer **3.2.0b6 (2022-08-09)**
+* **Supports REST API 2022-06-30-preview and earlier clients**
 
  [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0b6/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
 
@@ -279,7 +328,7 @@ This release includes the following updates:
 
 ### [**C#**](#tab/csharp)
 
-**Version 4.0.0-beta.4 (2022-06-08)**
+* Form Recognizer **4.0.0-beta.4 (2022-06-08)**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.FormRecognizer_4.0.0-beta.4/sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md)
 
@@ -289,7 +338,7 @@ This release includes the following updates:
 
 ### [**Java**](#tab/java)
 
-**Version 4.0.0-beta.5 (2022-06-07)**
+* Form Recognizer **4.0.0-beta.5 (2022-06-07)**
 
 [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_4.0.0-beta.5/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
 
@@ -299,7 +348,7 @@ This release includes the following updates:
 
 ### [**JavaScript**](#tab/javascript)
 
-**Version 4.0.0-beta.4 (2022-06-07)**
+* Form Recognizer **4.0.0-beta.4 (2022-06-07)**
 
  [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-js/blob/%40azure/ai-form-recognizer_4.0.0-beta.4/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md)
 
@@ -309,7 +358,7 @@ This release includes the following updates:
 
 ### [**Python**](#tab/python)
 
-**Version 3.2.0b5 (2022-06-07**
+* Form Recognizer **3.2.0b5 (2022-06-07**
 
  [**Changelog/Release History**](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-formrecognizer_3.2.0b5/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md)
 

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

@@ -447,9 +447,9 @@ sections:
 
           - You need an active [Azure account](https://azure.microsoft.com/free/cognitive-services/) and subscription with at least a **Reader** role to access Document Intelligence Studio.
 
-          - For **document analysis and prebuilt models**, you need full access—**Contributor** role—to at least one [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to enter the analyze page. Once you access the model analyze page, you can change the endpoint and key to access other resources, if needed.
+          - For **document analysis and prebuilt models**, you need full access—**Cognitive Services User** role—to at least one [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to enter the analyze page. Once you access the model analyze page, you can change the endpoint and key to access other resources, if needed.
 
-          - For **custom models**, you can either use a **Contributor** role, or use the endpoint and key of a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to create a project. You also need to have **Contributor** role to access to at least one blob storage account.
+          - For **custom models**, you can either use a **Cognitive Services User** role, or use the endpoint and key of a [Document Intelligence](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource to create a project. You also need to have **Storage Blob Data Contributor** role to access to at least one blob storage account.
 
           - For more information, *see* [Microsoft Entra built-in roles](../../role-based-access-control/built-in-roles.md).
 
@@ -468,10 +468,16 @@ sections:
           - Switching subscriptions or resources can be done under Settings -> Resource tab.
 
       - question: |
-          Why am I receiving an AuthorizationFailure error on Project Sharing, Auto Label, or OCR Upgrade when my Document Intelligence or Storage Account resource is configured with a firewall?
+          Why am I receiving a Storage error on Project Sharing, Auto Label, or OCR Upgrade when my Storage Account resource is configured with a firewall or virtual network?
         answer: |
 
-          Add our website IP address, 20.3.165.95, to the firewall allowlist for both Document Intelligence and Storage Account resources. This unique address is Document Intelligence Studio's dedicated IP address and can be safely allowed.
+          Please refer to [Managed identities for Document Intelligence](managed-identities.md) to set up up your Azure resources.
+
+      - question: |
+          Why am I receiving 'Access denied due to Virtual Network/Firewall rules' on Auto Label or OCR Upgrading when my Document Intelligence resource is configured with a firewall or virtual network?
+        answer: |
+
+          Add our website IP address, 20.3.165.95, to the firewall allowlist for Document Intelligence resource. This is Document Intelligence Studio's dedicated IP address and can be safely allowed.
 
       - question: |
           Can I reuse or customize the labeling experience from Studio and build it into my own application?

articles/ai-services/document-intelligence/managed-identities.md

@@ -95,7 +95,7 @@ In the following steps, we enable a system-assigned managed identity and grant D
 
 ## Grant access to your storage account
 
-You need to grant Document Intelligence access to your storage account before it can create, read, or delete blobs. Now that you've enabled Document Intelligence with a system-assigned managed identity, you can use Azure role-based access control (Azure RBAC), to give Document Intelligence access to Azure storage. The **Storage Blob Data Reader** role gives Document Intelligence (represented by the system-assigned managed identity) read and list access to the blob container and data.
+You need to grant Document Intelligence access to your storage account before it can read blobs. Now that you've enabled Document Intelligence with a system-assigned managed identity, you can use Azure role-based access control (Azure RBAC), to give Document Intelligence access to Azure storage. The **Storage Blob Data Reader** role gives Document Intelligence (represented by the system-assigned managed identity) read and list access to the blob container and data.
 
 1. Under **Permissions** select **Azure role assignments**:
 
@@ -130,6 +130,10 @@ You need to grant Document Intelligence access to your storage account before it
 
  That's it! You've completed the steps to enable a system-assigned managed identity. With managed identity and Azure RBAC, you granted Document Intelligence specific access rights to your storage resource without having to manage credentials such as SAS tokens.
 
+### Additional role assignment for Document Intelligence Studio
+
+If you are going to use Document Intelligence Studio and your storage account is configured with network restriction such as firewall or virtual network, an additional role, **Storage Blob Data Contributor**, needs to be assigned to your Document Intelligence service. Document Intelligence Studio requires this role to write blobs to your storage account when you perform Auto label, OCR upgrade, Human in the loop, or Project sharing operations.
+
 ## Next steps
 > [!div class="nextstepaction"]
 > [Configure secure access with managed identities and private endpoints](managed-identities-secured-access.md)