Skip to content

Commit b8e50c4

Browse files
author
Carey MacDonald
committed
Respond to feedback
1 parent 81b2284 commit b8e50c4

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

articles/search/cognitive-search-skill-pii-detection.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.date: 1/27/2020
1616
> [!IMPORTANT]
1717
> This skill is currently in public preview. Preview functionality is provided without a service level agreement, and is not recommended for production workloads. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). There is currently no portal or .NET SDK support.
1818
19-
The **PII Detection** skill extracts personally identifiable information from a text and gives you the option to mask it in the text in various ways. This skill uses the machine learning models provided by [Text Analytics](https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview) in Cognitive Services.
19+
The **PII Detection** skill extracts personally identifiable information from an input text and gives you the option to mask it from that text in various ways. This skill uses the machine learning models provided by [Text Analytics](https://docs.microsoft.com/azure/cognitive-services/text-analytics/overview) in Cognitive Services.
2020

2121
> [!NOTE]
2222
> As you expand scope by increasing the frequency of processing, adding more documents, or adding more AI algorithms, you will need to [attach a billable Cognitive Services resource](cognitive-search-attach-cognitive-services.md). Charges accrue when calling APIs in Cognitive Services, and for image extraction as part of the document-cracking stage in Azure Cognitive Search. There are no charges for text extraction from documents.
@@ -32,12 +32,12 @@ The maximum size of a record should be 50,000 characters as measured by [`String
3232

3333
## Skill parameters
3434

35-
Parameters are case-sensitive and are all optional.
35+
Parameters are case-sensitive and all are optional.
3636

3737
| Parameter name | Description |
3838
|--------------------|-------------|
3939
| defaultLanguageCode | Language code of the input text. For now, only `en` is supported. |
40-
| minimumPrecision | A value between 0 and 1. If the confidence score (in the `piiEntities` output) is lower than this value, the entity is not returned or masked. The default is 0. |
40+
| minimumPrecision | A value between 0.0 and 1.0. If the confidence score (in the `piiEntities` output) is lower than the set `minimumPrecision` value, the entity is not returned or masked. The default is 0.0. |
4141
| maskingMode | A parameter that provides various ways to mask the detected PII in the input text. The following options are supported: <ul><li>`none` (default): This means that no masking will be performed and the `maskedText` output will not be returned. </li><li> `redact`: This option will remove the detected entities from the input text and not replace them with anything. Note that in this case, the offset in the `piiEntities` output will be in relation to the original text, and not the masked text. </li><li> `replace`: This option will replace the detected entities with the character given in the `maskingCharacter` parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output `maskedText`.</li></ul> |
4242
| maskingCharacter | The character that will be used to masked the text if the `maskingMode` parameter is set to `replace`. The following options are supported: `*` (default), `#`, `X`. This parameter can only be `null` if `maskingMode` is not set to `replace`. |
4343

@@ -127,7 +127,7 @@ Parameters are case-sensitive and are all optional.
127127
## Error cases
128128
If the language code for the document is unsupported, an error is returned and no entities are extracted.
129129

130-
If the skill returns a warning for any reason, the output `maskedText` will be empty. This means that if you expect that output to exist for input into later skills, it will not work as intended. Keep this in mind when writing your skillset definition.
130+
If the skill returns a warning, the output `maskedText` may be empty. This means that if you expect that output to exist for input into later skills, it will not work as intended. Keep this in mind when writing your skillset definition.
131131

132132
## See also
133133

articles/search/whats-new.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Azure Search is now renamed to **Azure Cognitive Search** to reflect the expande
2222

2323
## Feature announcements
2424

25+
### February 2020
26+
27+
+ [PII Detection](cognitive-search-skill-pii-detection.md) is a cognitive skill used during indexing that extracts personally identifiable information from an input text and gives you the option to mask it from that text in various ways.
28+
2529
### January 2020
2630

2731
+ [Customer-managed encryption keys](search-security-manage-encryption-keys.md) is now generally available. If you are using REST, you can access the feature using `api-version=2019-05-06`. For managed code, the correct package is still [.NET SDK version 8.0-preview](search-dotnet-sdk-migration-version-9.md) even though the feature is out of preview.

0 commit comments

Comments
 (0)