Skip to content

Commit 704253f

Browse files
authored
Merge pull request #262791 from MicrosoftDocs/main
1/9/2024 AM Publish
2 parents ed10834 + e60b11d commit 704253f

File tree

47 files changed

+276
-107
lines changed

Some content is hidden

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

47 files changed

+276
-107
lines changed

articles/ai-services/document-intelligence/concept-retrieval-augumented-generation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ If you're looking for a specific section in a document, you can use semantic chu
119119

120120
```python
121121

122-
# Using SDK targeting 2023-10-31-preview
122+
# Using SDK targeting 2023-10-31-preview, make sure your resource is in one of these regions: East US, West US2, West Europe
123123
# pip install azure-ai-documentintelligence==1.0.0b1
124124
# pip install langchain langchain-community azure-ai-documentintelligence
125125

@@ -154,4 +154,4 @@ splits
154154

155155
* [Learn how to process your own forms and documents](quickstarts/try-document-intelligence-studio.md) with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio).
156156

157-
* Complete a [Document Intelligence quickstart](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.1.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.
157+
* Complete a [Document Intelligence quickstart](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.

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

Lines changed: 15 additions & 8 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.
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".
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
@@ -45,6 +45,13 @@ sections:
4545
4646
A Document Generative AI solution can enable you to chat with your documents, generate captivating content from them and access the power of Azure OpenAI models on your data. With Azure AI Document Intelligence and Azure OpenAI combined, you can build an enterprise application to seamlessly interact with your documents using natural languages, easily find answers and gain valuable insights, effortlessly generate new and engaging content from your existing documents. Check for more details in the [technical community blog](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/document-generative-ai-the-power-of-azure-ai-document/ba-p/3875015).
4747
48+
- question: |
49+
How is Document Intelligence related to Retrieval Augmented Generation (RAG)?
50+
answer: |
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).
53+
54+
4855
- question: |
4956
Which Document Intelligence use cases require special consideration?
5057
answer: |
@@ -104,7 +111,7 @@ sections:
104111
- question: |
105112
What is the accuracy score and how is it calculated?
106113
answer: |
107-
The output of a `build` (v3.0) or `train` (v2.1) custom model operation includes the estimated accuracy score. This score represents the model's ability to accurately predict the labeled value on a visually similar document.
114+
The output of a `build` (v3.0 and later versions) or `train` (v2.1) custom model operation includes the estimated accuracy score. This score represents the model's ability to accurately predict the labeled value on a visually similar document.
108115
109116
Accuracy is measured within a percentage value range between 0% (low) and 100% (high).
110117
@@ -159,7 +166,7 @@ sections:
159166
What is a bounding box?
160167
answer: |
161168
162-
A bounding box is an abstract rectangle that surrounds text elements on a document or form and is used as a reference point for object detection.
169+
A bounding box (`polygon` in v3.0 and later versions) is an abstract rectangle that surrounds text elements on a document or form and is used as a reference point for object detection.
163170
164171
- The bounding box specifies position using an x and y coordinate plane presented in an array of four numerical pairs. Each pair represents a corner of the box in the following order: top-left, top-right, bottom-right, bottom-left.
165172
@@ -205,7 +212,7 @@ sections:
205212
Where can I find the supported API version for the latest programming language SDKs?
206213
answer: |
207214
208-
This table provides links to the latest SDK versions and shows the relationship between supported Document Intelligence SDK and API versions: |
215+
This table provides links to the latest SDK versions and shows the relationship between supported Document Intelligence SDK and API versions:
209216
| Supported Language | Azure SDK reference|Supported API version|
210217
| ----- | -----|-----|
211218
| 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) |
@@ -242,7 +249,7 @@ sections:
242249
How can I specify a specific range of pages to be analyzed in a document?
243250
answer: |
244251
245-
- The parameter `pages`(supported in both v2.1 and v3.0 REST API) enables you to specify pages for multi-page PDF and TIFF documents. Accepted input includes the following ranges:
252+
- The parameter `pages`(supported in v2.1, v3.0 and later version REST API) enables you to specify pages for multi-page PDF and TIFF documents. Accepted input includes the following ranges:
246253
247254
- Single pages (for example,'1, 2' -> pages 1 and 2 are processed).- Finite (for example '2-5' -> pages 2 to 5 are processed)
248255
- Open-ended ranges (for example '5-' -> all the pages from page 5 are processed & for example, '-10' -> pages 1 to 10 are processed).
@@ -271,13 +278,13 @@ sections:
271278
answer: |
272279
Document Intelligence billing is calculated monthly based on the model type and number of pages analyzed:
273280
274-
- When you submit a document for analysis, all pages are analyzed unless you specify a page range with the `pages` parameter in your request. When the service analyzes Microsoft Excel and PowerPoint documents with the new Read OCR model, each worksheet and slide is counted as one page respectively.
281+
- When you submit a document for analysis, all pages are analyzed unless you specify a page range with the `pages` parameter in your request. When the service analyzes Microsoft Excel and PowerPoint documents with the Read OCR and Layout model, each worksheet and slide is counted as one page respectively.
275282
276283
- When analyzing PDF and TIFF files, each page in the PDF file or each image in the TIFF file is counted as one page with no maximum character limits.
277284
278-
- When analyzing Microsoft Word and HTML files supported by only the Read 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.
285+
- 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.
279286
280-
- When using the Read model, if your Microsoft Word, Excel, and PowerPoint pages with embedded images, each image is analyzed and counted as a page. Therefore, the total analyzed pages for Microsoft Office documents are equal to the sum of total text pages and total images analyzed. In the previous example if the document contains two embedded images, the total page count in the service output is three text pages plus two images equaling a total of five pages.
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.
281288
282289
- Training a custom model is always free with Document Intelligence. You’re only charged when a model is used to analyze a document.
283290

articles/ai-services/document-intelligence/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,7 @@ You can use Document Intelligence to automate document processing in application
487487
> [!div class="nextstepaction"]
488488
> [Return to custom model types](#custom-models)
489489
490+
::: moniker range=">=doc-intel-3.1.0"
490491
#### Custom classification model
491492

492493
:::image type="content" source="media/overview/custom-classifier-labeling.png" alt-text="{alt-text}":::

articles/ai-services/openai/how-to/function-calling.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ To force the model to call a specific function set the `tool_choice` parameter w
5151
> The default behavior (`tool_choice: "auto"`) is for the model to decide on its own whether to call a function and if so which function to call.
5252
5353
```python
54+
import os
5455
from openai import AzureOpenAI
5556
import json
5657

@@ -60,8 +61,6 @@ client = AzureOpenAI(
6061
api_version="2023-12-01-preview"
6162
)
6263

63-
from openai import OpenAI
64-
import json
6564

6665
# Example function hard coded to return the same weather
6766
# In production, this could be your backend API or an external API

articles/ai-services/openai/how-to/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ client = AzureOpenAI(
196196

197197
response = client.embeddings.create(
198198
input = "Your text string goes here",
199-
model= "text-embedding-ada-002"
199+
model= "text-embedding-ada-002" # model = "deployment_name".
200200
)
201201

202202
print(response.model_dump_json(indent=2))

articles/ai-services/openai/how-to/switching-endpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ client = AzureOpenAI(
6161

6262
<a name='azure-active-directory-authentication'></a>
6363

64-
### Microsoft Entra authentication
64+
### Microsoft Entra ID authentication
6565

6666
<table>
6767
<tr>

articles/ai-services/speech-service/personal-voice-how-to-use.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Here's example SSML in a request for text to speech with the voice name and the
2929

3030
```xml
3131
<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xmlns:mstts='http://www.w3.org/2001/mstts' xml:lang='en-US'>
32-
<voice xml:lang='en-US' xml:gender='Male' name='PhoenixV2Neural'>
32+
<voice name='PhoenixV2Neural'>
3333
<mstts:ttsembedding speakerProfileId='your speaker profile ID here'>
3434
I'm happy to hear that you find me amazing and that I have made your trip planning easier and more fun. 我很高兴听到你觉得我很了不起,我让你的旅行计划更轻松、更有趣。Je suis heureux d'apprendre que vous me trouvez incroyable et que j'ai rendu la planification de votre voyage plus facile et plus amusante.
3535
</mstts:ttsembedding>

articles/ai-studio/concepts/ai-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.custom:
88
- ignite-2023
99
ms.topic: conceptual
1010
ms.date: 12/14/2023
11-
ms.reviewer: eur
11+
ms.reviewer: Blackmist
1212
ms.author: eur
1313
author: eric-urban
1414
---

articles/ai-studio/concepts/deployments-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: Deploy models, flows, and web apps with Azure AI Studio
33
titleSuffix: Azure AI Studio
44
description: Learn about deploying models, flows, and web apps with Azure AI Studio.
5-
manager: nitinme
5+
manager: scottpolly
66
ms.service: azure-ai-studio
77
ms.custom:
88
- ignite-2023
99
ms.topic: conceptual
1010
ms.date: 12/7/2023
11-
ms.reviewer: eur
12-
ms.author: eur
13-
author: eric-urban
11+
ms.reviewer: fasantia
12+
ms.author: mopeakande
13+
author: msakande
1414
---
1515

1616
# Overview: Deploy models, flows, and web apps with Azure AI Studio
@@ -76,7 +76,7 @@ The model or flow that you deploy can be used in a web application hosted in Azu
7676

7777
## Planning AI safety for a deployed model
7878

79-
For Azure OpenAI models such as GPT-4, Azure AI Studio provides AI safety filter during the deployment to ensure responsible use of AI. AI content safety filter allows moderation of harmful and sensitive contents to promote the safety of AI-enhanced applications. In addition to AI safety filter, Azure AI Studio offers model monitoring for deployed models. Model monitoring for LLMs uses the latest GPT language models to monitor and alert when the outputs of the model perform poorly against the set thresholds of generation safety and quality. For example, you can configure a monitor to evaluate how well the models generated answers align with information from the input source ("groundedness") and closely match to a ground truth sentence or document ("similarity").
79+
For Azure OpenAI models such as GPT-4, Azure AI Studio provides AI safety filter during the deployment to ensure responsible use of AI. AI content safety filter allows moderation of harmful and sensitive contents to promote the safety of AI-enhanced applications. In addition to AI safety filter, Azure AI Studio offers model monitoring for deployed models. Model monitoring for LLMs uses the latest GPT language models to monitor and alert when the outputs of the model perform poorly against the set thresholds of generation safety and quality. For example, you can configure a monitor to evaluate how well the model's generated answers align with information from the input source ("groundedness") and closely match to a ground truth sentence or document ("similarity").
8080

8181
## Optimizing the performance of a deployed model
8282

articles/ai-studio/how-to/connections-add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.custom:
88
- ignite-2023
99
ms.topic: how-to
1010
ms.date: 11/15/2023
11-
ms.reviewer: eur
11+
ms.reviewer: Blackmist
1212
ms.author: eur
1313
author: eric-urban
1414
---

0 commit comments

Comments
 (0)