You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thank you for taking the time to contribute to the Microsoft Azure documentation.
4
4
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.
6
6
7
7
## Code of Conduct
8
8
@@ -14,16 +14,16 @@ For more information, see the [Code of Conduct FAQ](https://opensource.microsoft
14
14
15
15
There are many ways to contribute to the documentation. Review the following sections to find out which one is right for you.
16
16
17
-
### Reporting bugs and suggesting enhancements
17
+
### Report bugs and suggesting enhancements
18
18
19
19
Please use the Feedback tool at the bottom of any article to submit bugs and suggestions.
20
20
21
21

22
22
23
-
### Editing in GitHub
23
+
### Edit in GitHub
24
24
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.
26
26
27
-
###Pull requests
27
+
## Pull requests
28
28
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.
Copy file name to clipboardExpand all lines: articles/ai-services/document-intelligence/faq.yml
+18-16Lines changed: 18 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ sections:
33
33
34
34
- 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.
35
35
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-previewand later, will be renamed ```document intelligence```.
37
37
38
38
- 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.
39
39
@@ -49,7 +49,7 @@ sections:
49
49
How is Document Intelligence related to Retrieval Augmented Generation (RAG)?
50
50
answer: |
51
51
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).
53
53
54
54
55
55
- question: |
@@ -212,13 +212,14 @@ sections:
212
212
Where can I find the supported API version for the latest programming language SDKs?
213
213
answer: |
214
214
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|
For more information, *see* [Supported clients](sdk-overview-v4-0.md#supported-clients)
222
+
222
223
223
224
For more information, *see* [Supported clients](sdk-overview-v3-1.md#supported-clients)
224
225
@@ -284,7 +285,7 @@ sections:
284
285
285
286
- 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.
286
287
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.
288
289
289
290
- Training a custom model is always free with Document Intelligence. You’re only charged when a model is used to analyze a document.
290
291
@@ -370,11 +371,11 @@ sections:
370
371
answer: |
371
372
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.
372
373
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.
374
375
375
376
- Model Compose is currently available only for custom models trained with labels.
376
377
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.
378
379
379
380
Learn more about [composed models](concept-custom.md).
380
381
@@ -430,7 +431,7 @@ sections:
430
431
- question: |
431
432
Why was I charged for Layout when running custom training?
432
433
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.
434
435
435
436
- name: Storage account
436
437
questions:
@@ -459,7 +460,7 @@ sections:
459
460
460
461
- 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.
461
462
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.
463
464
464
465
- 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.
465
466
@@ -483,13 +484,14 @@ sections:
483
484
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?
484
485
answer: |
485
486
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.
487
488
488
489
- question: |
489
490
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?
490
491
answer: |
491
492
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
+
493
495
494
496
- question: |
495
497
Can I reuse or customize the labeling experience from Studio and build it into my own application?
Copy file name to clipboardExpand all lines: articles/ai-services/language-service/includes/overview-typical-workflow.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,19 +4,19 @@ author: aahill
4
4
manager: nitinme
5
5
ms.service: azure-ai-language
6
6
ms.topic: include
7
-
ms.date: 12/19/2023
7
+
ms.date: 01/31/2024
8
8
ms.author: aahi
9
9
ms.custom: ignite-fall-2021
10
10
---
11
11
12
12
## Typical workflow
13
13
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.
15
15
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.
17
17
18
18
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.
19
19
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.
0 commit comments