Skip to content

Commit ef5a197

Browse files
authored
Merge pull request #1625 from MicrosoftDocs/main
11/19/2024 PM Publish
2 parents 8dedabf + 0450a6a commit ef5a197

File tree

73 files changed

+611
-237
lines changed

Some content is hidden

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

73 files changed

+611
-237
lines changed

articles/ai-services/content-moderator/text-moderation-api.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
---
22
title: Text Moderation - Content Moderator
33
titleSuffix: Azure AI services
4-
description: Use text moderation for possible unwanted text, personal data, and custom lists of terms.
4+
description: Use text moderation to detect potentially unwanted text, personal data, and custom lists of terms.
55
#services: cognitive-services
66
author: PatrickFarley
77
manager: nitinme
88
ms.service: azure-ai-content-moderator
99
ms.topic: conceptual
10-
ms.date: 01/18/2024
10+
ms.date: 11/06/2024
1111
ms.author: pafarley
1212

1313
---
1414

15-
# Learn text moderation concepts
15+
# Text moderation concepts
1616

17-
Use Content Moderator's text moderation models to analyze text content, such as chat rooms, discussion boards, chatbots, e-commerce catalogs, and documents.
17+
[!INCLUDE [deprecation notice](includes/tool-deprecation.md)]
18+
19+
You can use Azure Content Moderator's text moderation models to analyze text content, such as chat rooms, discussion boards, chatbots, e-commerce catalogs, and documents.
1820

1921
The service response includes the following information:
2022

2123
- Profanity: term-based matching with built-in list of profane terms in various languages
2224
- Classification: machine-assisted classification into three categories
2325
- Personal data
24-
- Auto-corrected text
26+
- Autocorrected text
2527
- Original text
2628
- Language
2729

@@ -40,13 +42,13 @@ If the API detects any profane terms in any of the [supported languages](./langu
4042
```
4143

4244
> [!NOTE]
43-
> For the **language** parameter, assign `eng` or leave it empty to see the machine-assisted **classification** response (preview feature). **This feature supports English only**.
45+
> For the `language` parameter, assign `eng` or leave it empty to see the machine-assisted *classification* response (preview feature). **This feature supports English only**.
4446
>
45-
> For **profanity terms** detection, use the [ISO 639-3 code](http://www-01.sil.org/iso639-3/codes.asp) of the supported languages listed in this article, or leave it empty.
47+
> For *profanity terms* detection, use the [ISO 639-3 code](http://www-01.sil.org/iso639-3/codes.asp) of the supported languages listed in this article, or leave it empty.
4648

4749
## Classification
4850

49-
Content Moderator's machine-assisted **text classification feature** supports **English only**, and helps detect potentially undesired content. The flagged content may be assessed as inappropriate depending on context. It conveys the likelihood of each category. The feature uses a trained model to identify possible abusive, derogatory or discriminatory language. This includes slang, abbreviated words, offensive, and intentionally misspelled words.
51+
Content Moderator's machine-assisted *text classification feature* supports *English only*, and helps detect potentially undesired content. The flagged content might be assessed as inappropriate depending on context. It conveys the likelihood of each category. The feature uses a trained model to identify possible abusive, derogatory, or discriminatory language. This includes slang, abbreviated words, offensive, and intentionally misspelled words.
5052

5153
The following extract in the JSON extract shows an example output:
5254

@@ -67,10 +69,10 @@ The following extract in the JSON extract shows an example output:
6769

6870
### Explanation
6971

70-
- `Category1` refers to potential presence of language that may be considered sexually explicit or adult in certain situations.
71-
- `Category2` refers to potential presence of language that may be considered sexually suggestive or mature in certain situations.
72-
- `Category3` refers to potential presence of language that may be considered offensive in certain situations.
73-
- `Score` is between 0 and 1. The higher the score, the higher the model is predicting that the category may be applicable. This feature relies on a statistical model rather than manually coded outcomes. We recommend testing with your own content to determine how each category aligns to your requirements.
72+
- `Category1` refers to the potential presence of language that might be considered sexually explicit or adult in certain situations.
73+
- `Category2` refers to the potential presence of language that might be considered sexually suggestive or mature in certain situations.
74+
- `Category3` refers to the potential presence of language that might be considered offensive in certain situations.
75+
- `Score` is between 0 and 1. The higher the score, the higher the probability that the category might be applicable. This feature relies on a statistical model rather than manually coded outcomes. We recommend testing with your own content to determine how each category aligns to your requirements.
7476
- `ReviewRecommended` is either true or false depending on the internal score thresholds. Customers should assess whether to use this value or decide on custom thresholds based on their content policies.
7577

7678
## Personal data
@@ -120,24 +122,24 @@ The following example shows a sample response:
120122
}
121123
```
122124

123-
## Auto-correction
125+
## Autocorrection
124126

125-
The text moderation response can optionally return the text with basic auto-correction applied.
127+
The text moderation response can optionally return the text with basic autocorrection applied.
126128

127129
For example, the following input text has a misspelling.
128130

129131
> The quick brown fox jumps over the lazzy dog.
130132
131-
If you specify auto-correction, the response contains the corrected version of the text:
133+
If you specify autocorrection, the response contains the corrected version of the text:
132134

133135
> The quick brown fox jumps over the lazy dog.
134136
135-
## Creating and managing your custom lists of terms
137+
## Create and manage your custom lists of terms
136138

137-
While the default, global list of terms works great for most cases, you may want to screen against terms that are specific to your business needs. For example, you may want to filter out any competitive brand names from posts by users.
139+
While the default, global list of terms works great for most cases, you might want to screen against terms that are specific to your business needs. For example, you might want to filter out any competitive brand names from posts by users.
138140

139141
> [!NOTE]
140-
> There is a maximum limit of **5 term lists** with each list to **not exceed 10,000 terms**.
142+
> There is a maximum limit of *five term lists* with each list to *not exceed 10,000 terms*.
141143
>
142144
143145
The following example shows the matching List ID:
@@ -152,8 +154,8 @@ The following example shows the matching List ID:
152154
}
153155
```
154156

155-
The Content Moderator provides a [Term List API](/rest/api/cognitiveservices/contentmoderator/list-management-term-lists) with operations for managing custom term lists. Check out the [Term Lists .NET quickstart](term-lists-quickstart-dotnet.md) if you are familiar with Visual Studio and C#.
157+
The Content Moderator provides a [Term List API](/rest/api/cognitiveservices/contentmoderator/list-management-term-lists) with operations for managing custom term lists. Check out the [Term Lists .NET quickstart](term-lists-quickstart-dotnet.md) if you're familiar with Visual Studio and C#.
156158

157-
## Next steps
159+
## Related content
158160

159-
Test out the APIs with the [Quickstart](client-libraries.md).
161+
- [Quickstart: Use the Content Moderator client library](client-libraries.md)

articles/ai-services/content-understanding/audio/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ Content Understanding offers advanced audio capabilities, including:
6363

6464
Content Understanding offers customizable audio analyzer templates:
6565

66-
* **Post-call analytics**. Analyze call recordings to generate conversation transcripts, call summaries, sentiment assessments, and more.
66+
* **Post-call analysis**. Analyze call recordings to generate conversation transcripts, call summaries, sentiment assessments, and more.
6767

68-
* **Conversation summarization**. Generate transcriptions, summaries, and sentiment assessments from conversation audio recordings.
68+
* **Conversation analysis**. Generate transcriptions, summaries, and sentiment assessments from conversation audio recordings.
6969

7070
Start with a template or create a custom analyzer to meet your specific business needs.
7171

articles/ai-services/content-understanding/index.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ landingContent:
2020
- text: What is Azure AI Content Understanding?
2121
url: overview.md
2222
- text: Azure AI Content Understanding REST API
23-
url: /rest/api/aiservices/
23+
url: /rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true
2424
- text: FAQ
2525
url: faq.yml
2626

@@ -58,7 +58,7 @@ landingContent:
5858
- linkListType: whats-new
5959
links:
6060
- text: "What's new in Azure AI Content Understanding?"
61-
url: whats-new.md
61+
url: whats-new.md
6262

6363
- title: Reference
6464
linkLists:
@@ -68,6 +68,6 @@ landingContent:
6868
url: service-limits.md
6969
- text: Language and region support
7070
url: language-region-support.md
71-
7271

73-
72+
73+

articles/ai-services/content-understanding/quickstart/use-ai-foundry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To follow is an example of building an analyzer to extract key data from an invo
3535

3636
1. Upload a sample file of an invoice document or any other data relevant to your scenario.
3737

38-
:::image type="content" source="../media/analyzer-template/define-schema-upload.png" alt-text="Screenshot of upload step in user experience.":::
38+
:::image type="content" source="../media/analyzer-template/define-schema-upload.png" alt-text="Screenshot of upload step in user experience.":::
3939

4040
1. Content Understanding suggests analyzer templates based on your content type. For this example, select **Document analysis** and build your own schema tailored to the invoice scenario. When using your own data, select the analyzer template that best fits your needs, or create your own. See Analyzer templates for a full list of available templates.
4141

@@ -122,5 +122,5 @@ To follow are several of our video analyzer templates.
122122

123123
## Next steps
124124

125-
* In this quickstart, you learned how to create an analyzer in Azure AI Foundry. To use [REST API](/rest/api/aiservices/), *see* the [REST API quickstart](use-rest-api.md).
125+
* In this quickstart, you learned how to create an analyzer in Azure AI Foundry. To use [REST API](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true), *see* the [REST API quickstart](use-rest-api.md).
126126

articles/ai-services/content-understanding/quickstart/use-rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ ms.date: 11/19/2024
1212

1313
# Quickstart: Azure AI Content Understanding REST APIs
1414

15-
* Start using the latest preview version of the Azure AI Content Understanding [REST API (2024-12-01-preview)](/rest/api/aiservices/).
15+
* Start using the latest preview version of the Azure AI Content Understanding [REST API (2024-12-01-preview)](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true).
1616

1717
* Azure AI Content Understanding is a new generative AI-based [**Azure AI Service**](../../what-are-ai-services.md) that analyzes files of any modality (documents, images, videos, and audio) and extracts structured output in user-defined field formats.
1818

1919
* Integrate the Content Understanding service into your workflows and applications easily by calling our REST APIs.
2020

21-
* This quickstart guides you through using the [Content Understanding REST API](/rest/api/aiservices/) to create a custom analyzer and extract content and fields from your input.
21+
* This quickstart guides you through using the [Content Understanding REST API](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true) to create a custom analyzer and extract content and fields from your input.
2222

2323
## Prerequisites
2424

@@ -542,6 +542,6 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
542542

543543
## Next steps
544544

545-
* In this quickstart, you learned how to call the [REST API](/rest/api/aiservices/) to create a custom analyzer. For a user experience, try [**Azure AI Foundry**](https://ai.azure.com/).
545+
* In this quickstart, you learned how to call the [REST API](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true) to create a custom analyzer. For a user experience, try [**Azure AI Foundry**](https://ai.azure.com/).
546546

547547

articles/ai-services/content-understanding/service-limits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The following limits apply as of version 2024-12-01-preview.
9292
Classification fields can be defined to return either a single category (single-label classification) or multiple categories (multi-label classification).
9393

9494
* **Single-label classification**: Defined using a string field with the `classify` method. It can be a top-level basic field or a subfield within a group or table.
95-
* **Multi-label classification**: Represented as a list of string fields with the `classify` method. In the [REST API](/rest/api/aiservices/), `method=classify` and `enum` are specified on the inner string field and can only be a top-level field.
95+
* **Multi-label classification**: Represented as a list of string fields with the `classify` method. In the [REST API](/rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true), `method=classify` and `enum` are specified on the inner string field and can only be a top-level field.
9696

9797
*Note: Document analyzers currently don't support classification fields.*
9898

articles/ai-services/content-understanding/toc.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,15 @@ items:
4646
- name: Video
4747
href: video/overview.md
4848
displayName: video, audio, voice, recognition, synthesis, speaker, identification, verification, diarization, transcription, translation, language, understanding, sentiment, analysis, emotion, detection, pronunciation, model
49-
- Name: Reference
49+
- name: Responsible AI
50+
items:
51+
- name: Transparency note
52+
href: /legal/cognitive-services/content-understanding/transparency-note?toc=/azure/ai-services/content-understanding/toc.json&bc=/azure/ai-services/content-understanding/breadcrumb/toc.json
53+
- name: Data, privacy, and security
54+
href: /legal/cognitive-services/content-understanding/data-privacy?toc=/azure/ai-services/content-understanding/toc.json&bc=/azure/ai-services/content-understanding/breadcrumb/toc.json
55+
- name: Reference
5056
items:
5157
- name: REST API
5258
displayName: quota, tiers, throttle, max, adjustments, requests, support, ocr
53-
href: /rest/api/aiservices/
59+
href: /rest/api/contentunderstanding/operation-groups?view=rest-contentunderstanding-2024-12-01-preview&preserve-view=true
5460

0 commit comments

Comments
 (0)