Skip to content

Commit 1fc74ae

Browse files
authored
Merge pull request #264765 from MicrosoftDocs/main
1/31 11:00 AM IST Publish
2 parents e4ca2ec + e777911 commit 1fc74ae

File tree

367 files changed

+4510
-3677
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

367 files changed

+4510
-3677
lines changed

.openpublishing.publish.config.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,13 +1224,13 @@
12241224
".openpublishing.redirection.virtual-desktop.json",
12251225
".openpublishing.redirection.devops-project.json",
12261226
".openpublishing.redirection.sentinel.json",
1227+
"articles/active-directory-b2c/.openpublishing.redirection.active-directory-b2c.json",
12271228
"articles/ai-services/.openpublishing.redirection.ai-services-from-applied.json",
12281229
"articles/ai-services/.openpublishing.redirection.ai-services-from-cog.json",
12291230
"articles/ai-services/.openpublishing.redirection.applied-ai-old.json",
12301231
"articles/ai-services/.openpublishing.redirection.applied-ai-services.json",
12311232
"articles/ai-services/.openpublishing.redirection.cognitive-services.json",
12321233
"articles/ai-studio/.openpublishing.redirection.ai-studio.json",
1233-
"articles/energy-data-services/.openpublishing.redirection.energy-data-services.json",
12341234
"articles/azure-fluid-relay/.openpublishing.redirection.fluid-relay.json",
12351235
"articles/azure-netapp-files/.openpublishing.redirection.azure-netapp-files.json",
12361236
"articles/azure-relay/.openpublishing.redirection.relay.json",
@@ -1248,6 +1248,7 @@
12481248
"articles/deployment-environments/.openpublishing.redirection.deployment-environments.json",
12491249
"articles/dev-box/.openpublishing.redirection.dev-box.json",
12501250
"articles/digital-twins/.openpublishing.redirection.digital-twins.json",
1251+
"articles/energy-data-services/.openpublishing.redirection.energy-data-services.json",
12511252
"articles/event-grid/.openpublishing.redirection.event-grid.json",
12521253
"articles/event-hubs/.openpublishing.redirection.event-hubs.json",
12531254
"articles/governance/policy/.openpublishing.redirection.policy.json",
@@ -1264,8 +1265,8 @@
12641265
"articles/iot/.openpublishing.redirection.iot.json",
12651266
"articles/iot-hub/.openpublishing.redirection.iot-hub.json",
12661267
"articles/iot-operations/.openpublishing.redirection.iot-operations.json",
1267-
"articles/load-testing/.openpublishing.redirection.azure-load-testing.json",
12681268
"articles/lab-services/.openpublishing.redirection.lab-services.json",
1269+
"articles/load-testing/.openpublishing.redirection.azure-load-testing.json",
12691270
"articles/logic-apps/.openpublishing.redirection.logic-apps.json",
12701271
"articles/machine-learning/.openpublishing.redirection.machine-learning.json",
12711272
"articles/machine-learning/v1/.openpublishing.redirection.machine-learning-v1.json",

.openpublishing.redirection.active-directory.json

Lines changed: 447 additions & 1 deletion
Large diffs are not rendered by default.

.openpublishing.redirection.json

Lines changed: 121 additions & 1934 deletions
Large diffs are not rendered by default.

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for taking the time to contribute to the Microsoft Azure documentation.
44

5-
This guide covers some general topics related to contribution and refers to our [contributor guide](https://learn.microsoft.com/contribute) for more detailed explanations when required.
5+
This guide covers some general topics related to contribution and refers to our [contributor guide](/contribute/content) for more detailed explanations when required.
66

77
## Code of Conduct
88

@@ -14,16 +14,16 @@ For more information, see the [Code of Conduct FAQ](https://opensource.microsoft
1414

1515
There are many ways to contribute to the documentation. Review the following sections to find out which one is right for you.
1616

17-
### Reporting bugs and suggesting enhancements
17+
### Report bugs and suggesting enhancements
1818

1919
Please use the Feedback tool at the bottom of any article to submit bugs and suggestions.
2020

2121
![Feedback Tool](media/feedback-tool.png)
2222

23-
### Editing in GitHub
23+
### Edit in GitHub
2424

25-
Follow the guidance for [Quick edits to existing documents](https://learn.microsoft.com/contribute/content/#quick-edits-to-documentation) in our contributor guide.
25+
Follow the guidance for [Quick edits to existing documents](/contribute/content/#quick-edits-to-documentation) in our contributor guide.
2626

27-
### Pull requests
27+
## Pull requests
2828

29-
Review the guidance for [pull requests](https://learn.microsoft.com/contribute/how-to-write-workflows-major#pull-request-processing) and the contribution workflow in our contributor guide.
29+
Review the guidance for [pull-request processing](/contribute/content/process-pull-request) in our contributor guide.

articles/active-directory-b2c/.openpublishing.redirection.active-directory-b2c.json

Lines changed: 811 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ sections:
3333
3434
- There are no changes to pricing. The names "Cognitive Services" and "Azure Applied AI" continue to be used in Azure billing, cost analysis, price list, and price APIs.
3535
36-
- There are no breaking changes to application programming interfaces (APIs) or SDKs. Starting from 2023-10-31-preview, API and SDKs will be renamed to "documentintelligence".
36+
- There are no breaking changes to application programming interfaces (APIs) or SDKs. REST APIs and SDKs, 2023-10-31-preview and later, will be renamed ```document intelligence```.
3737
3838
- Some platforms are still awaiting the renaming update. All mention of Form Recognizer or Document Intelligence in our documentation refers to the same Azure service.
3939
@@ -49,7 +49,7 @@ sections:
4949
How is Document Intelligence related to Retrieval Augmented Generation (RAG)?
5050
answer: |
5151
52-
Semantic chunking is a key step in RAG to ensure its efficient storage and retrieval. The Document Intelligence [Layout model](concept-layout.md) offers a comprehensive solution for advanced content extraction and document structure analysis capabilities. With the Layout model, you can easily extract text and structural elements to divide large bodies of text into smaller, meaningful chunks based on semantic content rather than arbitrary splits. The extracted information can be conveniently outputted to Markdown format, enabling you to define your semantic chunking strategy based on provided building blocks. Check for more details in this [article](concept-retrieval-augumented-generation.md).
52+
Semantic chunking is a key step in RAG to ensure its efficient storage and retrieval. The Document Intelligence [Layout model](concept-layout.md) offers a comprehensive solution for advanced content extraction and document structure analysis capabilities. With the Layout model, you can easily extract text and structural elements to divide large bodies of text into smaller, meaningful chunks based on semantic content rather than arbitrary splits. The extracted information can be conveniently outputted to Markdown format, enabling you to define your semantic chunking strategy based on provided building blocks. Check for more details in [Retrieval Augmented Generation](concept-retrieval-augumented-generation.md).
5353
5454
5555
- question: |
@@ -212,13 +212,14 @@ sections:
212212
Where can I find the supported API version for the latest programming language SDKs?
213213
answer: |
214214
215-
This table provides links to the latest SDK versions and shows the relationship between supported Document Intelligence SDK and API versions:
216-
| Supported Language | Azure SDK reference|Supported API version|
217-
| ----- | -----|-----|
218-
| C#/.NET| [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0/index.html)|[**v3.0**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) |
219-
| Java | [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0/index.html)| [**v3.0**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) |
220-
| JavaScript | [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-ai-form-recognizer/4.0.0/index.html)|[**v3.0**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) |
221-
| Python | [3.2.0](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-formrecognizer/3.2.0/index.html) |[**v3.0**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) |
215+
This table provides links to the latest SDK versions and shows the relationship between supported Document Intelligence SDK and API versions:
216+
217+
| Supported Language Azure SDK reference|Supported API versions|
218+
| ----- | -----|
219+
| &bull; C#/.NET: [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0/index.html)<br><br>&bull; Java: [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0/index.html)<br><br>&bull; JavaScript: [4.0.0](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-ai-form-recognizer/4.0.0/index.html)<br><br>&bull; Python [3.2.0](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-formrecognizer/3.2.0/index.html) |[**2023-10-31-preview**](https://learn.microsoft.com/rest/api/aiservices/operation-groups?view=rest-aiservices-2023-10-31-preview&preserve-view=true&tabs=HTTP&branch=main)<br>[**v3.0**](/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP)</br> [**v2.1**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2-1/operations/AnalyzeBusinessCardAsync)</br>[**v2.0**](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v2/operations/AnalyzeLayoutAsync) |
220+
221+
For more information, *see* [Supported clients](sdk-overview-v4-0.md#supported-clients)
222+
222223
223224
For more information, *see* [Supported clients](sdk-overview-v3-1.md#supported-clients)
224225
@@ -284,7 +285,7 @@ sections:
284285
285286
- When analyzing Microsoft Word and HTML files supported by the Read and Layout model, pages are counted in blocks of 3,000 characters each. For example, if your document contains 7,000 characters, the two pages with 3,000 characters each and one page with 1,000 characters adds up to a total of three pages.
286287
287-
- When using the Read or Layout model to analyze Microsoft Word, Excel, PowerPoint and HTML files, embedded or linked images are not supported. So they will not be counted as additional images for chargeing.
288+
- When using the Read or Layout model to analyze Microsoft Word, Excel, PowerPoint and HTML files, embedded or linked images aren't supported. So they aren't counted as added images.
288289
289290
- Training a custom model is always free with Document Intelligence. You’re only charged when a model is used to analyze a document.
290291
@@ -370,11 +371,11 @@ sections:
370371
answer: |
371372
With the [Model Compose](how-to-guides/compose-custom-models.md?view=doc-intel-2.1.0&preserve-view=true#create-a-composed-model) operation, you can assign up to 200 models to a single model ID.
372373
373-
- When you make the Analyze request with a composed modelID, Document Intelligence classifies the submitted form, chooses the best model, and returns the results.
374+
- When you make the ```Analyze Document``` request with a composed modelID, Document Intelligence classifies the submitted form, chooses the best model, and returns the results.
374375
375376
- Model Compose is currently available only for custom models trained with labels.
376377
377-
- Analyzing a document with composed models is identical to analyzing a document with a single model, the Analyze result returns a ```docType``` property indicating which of the component models was selected for analyzing the document. There's no change in pricing for analyzing a document with an individual custom model or a composed custom model.
378+
- Analyzing a document with composed models is identical to analyzing a document with a single model, the ```Analyze Document``` result returns a ```docType``` property indicating which of the component models was selected for analyzing the document. There's no change in pricing for analyzing a document with an individual custom model or a composed custom model.
378379
379380
Learn more about [composed models](concept-custom.md).
380381
@@ -430,7 +431,7 @@ sections:
430431
- question: |
431432
Why was I charged for Layout when running custom training?
432433
answer: |
433-
Layout is required to generate lables for your dataset. If the data set you run custom training on does not have label files available, they will be auto-generated for you.
434+
Layout is required to generate labels for your dataset. If the data set you run custom training on doesn't have label files available, they're autogenerated for you.
434435
435436
- name: Storage account
436437
questions:
@@ -459,7 +460,7 @@ sections:
459460
460461
- 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.
461462
462-
- 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.
463+
- 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. Once you access the model analyze page, you can change the endpoint and key to access other resources, if needed.
463464
464465
- 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.
465466
@@ -483,13 +484,14 @@ sections:
483484
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?
484485
answer: |
485486
486-
Please refer to [Managed identities for Document Intelligence](managed-identities.md) to set up up your Azure resources.
487+
Refer to [Managed identities for Document Intelligence](managed-identities.md) to set up your Azure resources.
487488
488489
- question: |
489490
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?
490491
answer: |
491492
492-
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.
493+
Our website dedicated IP address, 20.3.165.95, can be safely added to the firewall allowlist for your Document Intelligence resource.
494+
493495
494496
- question: |
495497
Can I reuse or customize the labeling experience from Studio and build it into my own application?

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ metadata:
1212
ms.topic: landing-page
1313
author: laujan
1414
ms.author: lajanuar
15-
ms.date: 01/02/2024
15+
ms.date: 01/31/2024
1616
monikerRange: '<=doc-intel-4.0.0'
1717
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
18-
# Limits: https://review.learn.microsoft.com/help/contribute/contribute-how-to-write-landing-page?branch=main#limits
18+
# Limits: https://learn.learn.microsoft.com/help/contribute/contribute-how-to-write-landing-page?branch=main#limits
1919

2020
landingContent:
2121
# Cards and links should be based on top customer tasks or top subjects
@@ -35,11 +35,11 @@ landingContent:
3535
url: whats-new.md
3636
- linkListType: reference
3737
links:
38-
- text: 🆕 SDK overview 2023-10-31-preview (preview)
38+
- text: 🆕 SDK overview ```2023-10-31-preview``` (preview)
3939
url: sdk-overview-v4-0.md
40-
- text: SDK overview 2023-07-31 latest (GA)
40+
- text: SDK overview ```2023-07-31``` latest (GA)
4141
url: sdk-overview-v3-1.md
42-
- text: SDK overview 2022-08-31 legacy (GA)
42+
- text: SDK overview ```2022-08-31``` legacy (GA)
4343
url: sdk-overview-v3-0.md
4444

4545
#Card 2

articles/ai-services/language-service/includes/overview-typical-workflow.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ author: aahill
44
manager: nitinme
55
ms.service: azure-ai-language
66
ms.topic: include
7-
ms.date: 12/19/2023
7+
ms.date: 01/31/2024
88
ms.author: aahi
99
ms.custom: ignite-fall-2021
1010
---
1111

1212
## Typical workflow
1313

14-
To use this feature, you submit data for analysis and handle the API output in your application. Analysis is performed as-is, with no additional customization to the model used on your data.
14+
To use this feature, you submit data for analysis and handle the API output in your application. Analysis is performed as-is, with no added customization to the model used on your data.
1515

16-
1. Create an Azure AI Language resource, which grants you access to the features offered by Azure AI Language. It will generate a password (called a key) and an endpoint URL that you'll use to authenticate API requests.
16+
1. Create an Azure AI Language resource, which grants you access to the features offered by Azure AI Language. It generates a password (called a key) and an endpoint URL that you use to authenticate API requests.
1717

1818
2. Create a request using either the REST API or the client library for C#, Java, JavaScript, and Python. You can also send asynchronous calls with a batch request to combine API requests for multiple features into a single call.
1919

20-
3. Send the request containing your data as raw unstructured text. Your key and endpoint will be used for authentication.
20+
3. Send the request containing your text data. Your key and endpoint are used for authentication.
2121

22-
4. Stream or store the response locally.
22+
4. Stream or store the response locally.

0 commit comments

Comments
 (0)