Skip to content

Commit f2ea9a5

Browse files
committed
Merge branch 'release-build-2024-release' of https://github.com/MicrosoftDocs/azure-docs-pr into shiproom-fix
2 parents 865b011 + 3a04ad9 commit f2ea9a5

File tree

1,025 files changed

+30174
-8966
lines changed

Some content is hidden

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

1,025 files changed

+30174
-8966
lines changed

.openpublishing.publish.config.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1004,6 +1004,12 @@
10041004
"branch": "docs-snippets",
10051005
"branch_mapping": {}
10061006
},
1007+
{
1008+
"path_to_root": "functions-openai-extension",
1009+
"url": "https://github.com/Azure/azure-functions-openai-extension",
1010+
"branch": "main",
1011+
"branch_mapping": {}
1012+
},
10071013
{
10081014
"path_to_root": "cosmos-db-nosql-dotnet-samples",
10091015
"url": "https://github.com/azure-samples/cosmos-db-nosql-dotnet-samples",
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: include file
3+
description: include file
4+
author: eur
5+
ms.reviewer: eur
6+
ms.author: eric-urban
7+
ms.service: azure-ai-studio
8+
ms.topic: include
9+
ms.date: 2/22/2024
10+
ms.custom: include
11+
---
12+
13+
> [!NOTE]
14+
> This feature is currently in public preview. This preview is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
author: eric-urban
3+
ms.service: azure-ai-services
4+
ms.date: 5/21/2024
5+
ms.topic: include
6+
ms.author: eur
7+
---
8+
9+
> [!div class="checklist"]
10+
> - Azure subscription - [Create one for free](https://azure.microsoft.com/free/cognitive-services).
11+
> - Some AI services features are free to try in AI Studio. For access to all capabilities described in this article, you need to [connect AI services to your hub in AI Studio](../../../ai-studio/ai-services/connect-ai-services.md#connect-to-ai-services).

articles/ai-services/language-service/personally-identifiable-information/concepts/conversations-entity-categories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Entity categories recognized by Conversational Personally Identifiable Information (detection) in Azure AI Language
33
titleSuffix: Azure AI services
4-
description: Learn about the entities the Conversational PII feature (preview) can recognize from conversation inputs.
4+
description: Learn about the entities the Conversational PII feature can recognize from conversation inputs.
55
#services: cognitive-services
66
author: jboback
77
manager: nitinme

articles/ai-services/language-service/personally-identifiable-information/language-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.custom: language-service-pii
1414

1515
# Personally Identifiable Information (PII) detection language support
1616

17-
Use this article to learn which natural languages are supported by the PII and conversation PII (preview) features of Azure AI Language.
17+
Use this article to learn which natural languages are supported by the PII and conversation PII features of Azure AI Language.
1818

1919
# [PII for documents](#tab/documents)
2020

articles/ai-services/language-service/personally-identifiable-information/overview.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ ms.custom: language-service-pii
1414

1515
# What is Personally Identifiable Information (PII) detection in Azure AI Language?
1616

17-
PII detection is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. The PII detection feature can **identify, categorize, and redact** sensitive information in unstructured text. For example: phone numbers, email addresses, and forms of identification. The method for utilizing PII in conversations is different than other use cases, and articles for this use are separate.
17+
As of June 2024, we now provide General Availability support for the Conversational PII service (English-language only).
18+
Customers can now redact transcripts, chats, and other text written in a conversational style (i.e. text with “um”s, “ah”s, multiple speakers, and the spelling out of words for more clarity) with better confidence in AI quality, Azure SLA support and production environment support, and enterprise-grade security in mind.
19+
20+
PII detection is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. The PII detection feature can **identify, categorize, and redact** sensitive information in unstructured text. For example: phone numbers, email addresses, and forms of identification. Azure AI Language supports general text PII redaction, as well as [Conversational PII](how-to-call-for-conversations.md), a specialized model for handling speech transcriptions and the more informal, conversational tone of meeting and call transcripts. The service also supports [Native Document PII redaction](#native-document-support), where the input and output are structured document files.
1821

1922
* [**Quickstarts**](quickstart.md) are getting-started instructions to guide you through making requests to the service.
2023
* [**How-to guides**](how-to-call.md) contain instructions for using the service in more specific or customized ways.
2124
* The [**conceptual articles**](concepts/entity-categories.md) provide in-depth explanations of the service's functionality and features.
2225

23-
PII comes into two shapes:
24-
25-
* [PII](how-to-call.md) - works on unstructured text.
26-
* [Conversation PII (preview)](how-to-call-for-conversations.md) - tailored model to work on conversation transcription.
27-
2826
[!INCLUDE [Typical workflow for pre-configured language features](../includes/overview-typical-workflow.md)]
2927

3028
## Native document support

articles/ai-services/language-service/summarization/custom/how-to/data-formats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This page contains information about how to select and prepare data in order to
2121
2222
## Custom summarization document sample format
2323

24-
In the abstractive document summarization scenario, each document (whether it has a provided label or not) is expected to be provided in a plain .txt file. The file contains one or more lines. If multiple lines are provided, each is assumed to be a paragraph of the document. The following is an example document with three paragraphs.
24+
In the abstractive text summarization scenario, each document (whether it has a provided label or not) is expected to be provided in a plain .txt file. The file contains one or more lines. If multiple lines are provided, each is assumed to be a paragraph of the document. The following is an example document with three paragraphs.
2525

2626
*At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality.*
2727

@@ -66,7 +66,7 @@ In the abstractive document summarization scenario, each document (whether it ha
6666

6767
## Sample mapping JSON format
6868

69-
In both document and conversation summarization scenarios, a set of documents and corresponding labels can be provided in a single JSON file that references individual document/conversation and summary files.
69+
In both text and conversation summarization scenarios, a set of documents and corresponding labels can be provided in a single JSON file that references individual document/conversation and summary files.
7070

7171
The JSON file is expected to contain the following fields:
7272

@@ -96,7 +96,7 @@ The JSON file is expected to contain the following fields:
9696
```
9797
## Custom document summarization mapping sample
9898

99-
The following is an example mapping file for the abstractive document summarization scenario with three documents and corresponding labels.
99+
The following is an example mapping file for the abstractive text summarization scenario with three documents and corresponding labels.
100100

101101
```json
102102
{

articles/ai-services/language-service/summarization/how-to/conversation-summarization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ For easier navigation, here are links to the corresponding sections for each ser
4747

4848
The conversation summarization API uses natural language processing techniques to summarize conversations into shorter summaries per request. Conversation summarization can summarize for issues and resolutions discussed in a two-party conversation or summarize a long conversation into chapters and a short narrative for each chapter.
4949

50-
There's another feature in Azure AI Language named [document summarization](../overview.md?tabs=document-summarization) that is more suitable to summarize documents into concise summaries. When you're deciding between document summarization and conversation summarization, consider the following points:
51-
* Input format: Conversation summarization can operate on both chat text and speech transcripts, which have speakers and their utterances. Document summarization operates using simple text, or Word, PDF, or PowerPoint formats.
50+
There's another feature in Azure AI Language named [text summarization](../overview.md?tabs=text-summarization) that is more suitable to summarize documents into concise summaries. When you're deciding between text summarization and conversation summarization, consider the following points:
51+
* Input format: Conversation summarization can operate on both chat text and speech transcripts, which have speakers and their utterances. Text summarization operates using simple text, or Word, PDF, or PowerPoint formats.
5252
* Purpose of summarization: for example, conversation issue and resolution summarization returns a reason and the resolution for a chat between a customer and a customer service agent.
5353

5454
## Submitting data

articles/ai-services/language-service/summarization/how-to/document-summarization.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ ms.custom:
1414
- ignite-2023
1515
---
1616

17-
# How to use document summarization
17+
# How to use text summarization
1818

19-
Document summarization is designed to shorten content that users consider too long to read. Both extractive and abstractive summarization condense articles, papers, or documents to key sentences.
19+
Text summarization is designed to shorten content that users consider too long to read. Both extractive and abstractive summarization condense articles, papers, or documents to key sentences.
2020

2121
**Extractive summarization**: Produces a summary by extracting sentences that collectively represent the most important or relevant information within the original content.
2222

@@ -32,8 +32,8 @@ For easier navigation, here are links to the corresponding sections for each ser
3232

3333
|Aspect |Section |
3434
|-------------|-------------------------------------------------------------------|
35-
|Extractive |[Extractive Summarization](#try-document-extractive-summarization) |
36-
|Abstractive |[Abstrctive Summarization](#try-document-abstractive-summarization)|
35+
|Extractive |[Extractive Summarization](#try-text-extractive-summarization) |
36+
|Abstractive |[Abstractive Summarization](#try-text-abstractive-summarization)|
3737
|Query-focused|[Query-focused Summarization](#query-based-summarization) |
3838

3939

@@ -61,15 +61,15 @@ You submit documents to the API as strings of text. Analysis is performed upon r
6161

6262
When you use this feature, the API results are available for 24 hours from the time the request was ingested, and is indicated in the response. After this time period, the results are purged and are no longer available for retrieval.
6363

64-
### Getting document summarization results
64+
### Getting text summarization results
6565

6666
When you get results from language detection, you can stream the results to an application or save the output to a file on the local system.
6767

6868
The following is an example of content you might submit for summarization, which is extracted using the Microsoft blog article [A holistic representation toward integrative AI](https://www.microsoft.com/research/blog/a-holistic-representation-toward-integrative-ai/). This article is only an example, the API can accept longer input text. See the data limits section for more information.
6969

7070
*"At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there’s magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code enables us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pretrained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks."*
7171

72-
The document summarization API request is processed upon receipt of the request by creating a job for the API backend. If the job succeeded, the output of the API is returned. The output is available for retrieval for 24 hours. After this time, the output is purged. Due to multilingual and emoji support, the response might contain text offsets. See [how to process offsets](../../concepts/multilingual-emoji-support.md) for more information.
72+
The text summarization API request is processed upon receipt of the request by creating a job for the API backend. If the job succeeded, the output of the API is returned. The output is available for retrieval for 24 hours. After this time, the output is purged. Due to multilingual and emoji support, the response might contain text offsets. See [how to process offsets](../../concepts/multilingual-emoji-support.md) for more information.
7373

7474
When you use the above example, the API might return the following summarized sentences:
7575

@@ -81,9 +81,9 @@ When you use the above example, the API might return the following summarized se
8181
**Abstractive summarization**:
8282
- "Microsoft is taking a more holistic, human-centric approach to learning and understanding. We believe XYZ-code enables us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. Over the past five years, we have achieved human performance on benchmarks in."
8383

84-
### Try document extractive summarization
84+
### Try text extractive summarization
8585

86-
You can use document extractive summarization to get summaries of articles, papers, or documents. To see an example, see the [quickstart article](../quickstart.md).
86+
You can use text extractive summarization to get summaries of articles, papers, or documents. To see an example, see the [quickstart article](../quickstart.md).
8787

8888
You can use the `sentenceCount` parameter to guide how many sentences are returned, with `3` being the default. The range is from 1 to 20.
8989

@@ -94,20 +94,20 @@ You can also use the `sortby` parameter to specify in what order the extracted s
9494
|Rank | Order sentences according to their relevance to the input document, as decided by the service. |
9595
|Offset | Keeps the original order in which the sentences appear in the input document. |
9696

97-
### Try document abstractive summarization
97+
### Try text abstractive summarization
9898

99-
The following example gets you started with document abstractive summarization:
99+
The following example gets you started with text abstractive summarization:
100100

101101
1. Copy the command below into a text editor. The BASH example uses the `\` line continuation character. If your console or terminal uses a different line continuation character, use that character instead.
102102

103103
```bash
104-
curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/jobs?api-version=2022-10-01-preview \
104+
curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/jobs?api-version=2023-04-01 \
105105
-H "Content-Type: application/json" \
106106
-H "Ocp-Apim-Subscription-Key: <your-language-resource-key>" \
107107
-d \
108108
'
109109
{
110-
"displayName": "Document Abstractive Summarization Task Example",
110+
"displayName": "Text Abstractive Summarization Task Example",
111111
"analysisInput": {
112112
"documents": [
113113
{
@@ -120,7 +120,7 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/
120120
"tasks": [
121121
{
122122
"kind": "AbstractiveSummarization",
123-
"taskName": "Document Abstractive Summarization Task 1",
123+
"taskName": "Text Abstractive Summarization Task 1",
124124
"parameters": {
125125
"summaryLength": short
126126
}
@@ -153,7 +153,7 @@ curl -X GET https://<your-language-resource-endpoint>/language/analyze-text/jobs
153153
-H "Ocp-Apim-Subscription-Key: <your-language-resource-key>"
154154
```
155155

156-
### Abstractive document summarization example JSON response
156+
### Abstractive text summarization example JSON response
157157

158158
```json
159159
{
@@ -163,7 +163,7 @@ curl -X GET https://<your-language-resource-endpoint>/language/analyze-text/jobs
163163
"expirationDateTime": "2022-09-09T16:44:53Z",
164164
"status": "succeeded",
165165
"errors": [],
166-
"displayName": "Document Abstractive Summarization Task Example",
166+
"displayName": "Text Abstractive Summarization Task Example",
167167
"tasks": {
168168
"completed": 1,
169169
"failed": 0,
@@ -172,7 +172,7 @@ curl -X GET https://<your-language-resource-endpoint>/language/analyze-text/jobs
172172
"items": [
173173
{
174174
"kind": "AbstractiveSummarizationLROResults",
175-
"taskName": "Document Abstractive Summarization Task 1",
175+
"taskName": "Text Abstractive Summarization Task 1",
176176
"lastUpdateDateTime": "2022-09-08T16:45:14.0717206Z",
177177
"status": "succeeded",
178178
"results": {
@@ -212,7 +212,7 @@ The following cURL commands are executed from a BASH shell. Edit these commands
212212

213213
## Query based summarization
214214

215-
The query-based document summarization API is an extension to the existing document summarization API.
215+
The query-based text summarization API is an extension to the existing text summarization API.
216216

217217
The biggest difference is a new `query` field in the request body (under `tasks` > `parameters` > `query`). Additionally, there's a new way to specify the preferred `summaryLength` in "buckets" of short/medium/long, which we recommend using instead of `sentenceCount`, especially when using abstractive. Below is an example request:
218218

@@ -223,7 +223,7 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/
223223
-d \
224224
'
225225
{
226-
"displayName": "Document Extractive Summarization Task Example",
226+
"displayName": "Text Extractive Summarization Task Example",
227227
"analysisInput": {
228228
"documents": [
229229
{
@@ -233,13 +233,20 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/
233233
}
234234
]
235235
},
236-
"tasks": [
236+
"tasks": [
237237
{
238+
"kind": "AbstractiveSummarization",
239+
"taskName": "Query-based Abstractive Summarization",
240+
"parameters": {
241+
"query": "XYZ-code",
242+
"summaryLength": "short"
243+
}
244+
}, {
238245
"kind": "ExtractiveSummarization",
239-
"taskName": "Document Extractive Summarization Task 1",
246+
"taskName": "Query_based Extractive Summarization",
240247
"parameters": {
241-
"query": "XYZ-code",
242-
"summaryLength": short
248+
"query": "XYZ-code",
249+
"sentenceCount": 3
243250
}
244251
}
245252
]
@@ -249,6 +256,7 @@ curl -i -X POST https://<your-language-resource-endpoint>/language/analyze-text/
249256

250257
### Using the summaryParameter
251258
For the `summaryLength` parameter, three values are accepted:
259+
* oneSentence: Generates a summary of mostly 1 sentence, with around 80 tokens.
252260
* short: Generates a summary of mostly 2-3 sentences, with around 120 tokens.
253261
* medium: Generates a summary of mostly 4-6 sentences, with around 170 tokens.
254262
* long: Generates a summary of mostly over 7 sentences, with around 210 tokens.

0 commit comments

Comments
 (0)