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: articles/ai-services/content-moderator/text-moderation-api.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,29 @@
1
1
---
2
2
title: Text Moderation - Content Moderator
3
3
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.
5
5
#services: cognitive-services
6
6
author: PatrickFarley
7
7
manager: nitinme
8
8
ms.service: azure-ai-content-moderator
9
9
ms.topic: conceptual
10
-
ms.date: 01/18/2024
10
+
ms.date: 11/06/2024
11
11
ms.author: pafarley
12
12
13
13
---
14
14
15
-
# Learn text moderation concepts
15
+
# Text moderation concepts
16
16
17
-
Use Content Moderator's text moderation models to analyze text content, such as chat rooms, discussion boards, chatbots, e-commerce catalogs, and documents.
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.
18
20
19
21
The service response includes the following information:
20
22
21
23
- Profanity: term-based matching with built-in list of profane terms in various languages
22
24
- Classification: machine-assisted classification into three categories
23
25
- Personal data
24
-
-Auto-corrected text
26
+
-Autocorrected text
25
27
- Original text
26
28
- Language
27
29
@@ -40,13 +42,13 @@ If the API detects any profane terms in any of the [supported languages](./langu
40
42
```
41
43
42
44
> [!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**.
44
46
>
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.
46
48
47
49
## Classification
48
50
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.
50
52
51
53
The following extract in the JSON extract shows an example output:
52
54
@@ -67,10 +69,10 @@ The following extract in the JSON extract shows an example output:
67
69
68
70
### Explanation
69
71
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.
74
76
-`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.
75
77
76
78
## Personal data
@@ -120,24 +122,24 @@ The following example shows a sample response:
120
122
}
121
123
```
122
124
123
-
## Auto-correction
125
+
## Autocorrection
124
126
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.
126
128
127
129
For example, the following input text has a misspelling.
128
130
129
131
> The quick brown fox jumps over the lazzy dog.
130
132
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:
132
134
133
135
> The quick brown fox jumps over the lazy dog.
134
136
135
-
## Creating and managing your custom lists of terms
137
+
## Create and manage your custom lists of terms
136
138
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.
138
140
139
141
> [!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*.
141
143
>
142
144
143
145
The following example shows the matching List ID:
@@ -152,8 +154,8 @@ The following example shows the matching List ID:
152
154
}
153
155
```
154
156
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#.
156
158
157
-
## Next steps
159
+
## Related content
158
160
159
-
Test out the APIs with the [Quickstart](client-libraries.md).
161
+
- [Quickstart: Use the Content Moderator client library](client-libraries.md)
Copy file name to clipboardExpand all lines: articles/ai-services/content-understanding/quickstart/use-ai-foundry.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ To follow is an example of building an analyzer to extract key data from an invo
35
35
36
36
1. Upload a sample file of an invoice document or any other data relevant to your scenario.
37
37
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.":::
39
39
40
40
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.
41
41
@@ -122,5 +122,5 @@ To follow are several of our video analyzer templates.
122
122
123
123
## Next steps
124
124
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).
Copy file name to clipboardExpand all lines: articles/ai-services/content-understanding/quickstart/use-rest-api.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ ms.date: 11/19/2024
12
12
13
13
# Quickstart: Azure AI Content Understanding REST APIs
14
14
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).
16
16
17
17
* 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.
18
18
19
19
* Integrate the Content Understanding service into your workflows and applications easily by calling our REST APIs.
20
20
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.
22
22
23
23
## Prerequisites
24
24
@@ -542,6 +542,6 @@ The 200 (`OK`) JSON response includes a `status` field indicating the status of
542
542
543
543
## Next steps
544
544
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/).
Copy file name to clipboardExpand all lines: articles/ai-services/content-understanding/service-limits.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ The following limits apply as of version 2024-12-01-preview.
92
92
Classification fields can be defined to return either a single category (single-label classification) or multiple categories (multi-label classification).
93
93
94
94
***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.
96
96
97
97
*Note: Document analyzers currently don't support classification fields.*
0 commit comments