Skip to content

Commit e679d16

Browse files
authored
[TA] Add known issues (Azure#19272)
- `CategoriesFilter` not working on analyze Azure#19237. - `Statistics` for `AnalyzeBatchActionsResult` are not currently returned even if the user passes `IncludeStatistics = true`. Azure#19268
1 parent 6ceeb85 commit e679d16

File tree

3 files changed

+16
-7
lines changed

3 files changed

+16
-7
lines changed

sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
### Fixes
2525
- `RecognizePiiEntities` and `TextAnalyticsActions.RecognizePiiEntitiesOptions` were always passing `PiiEntityDomainType.PHI`. Now, it is only passed when requested by the user [19086](https://github.com/Azure/azure-sdk-for-net/issues/19086).
2626

27+
### Known Issues
28+
- The parameter `CategoriesFilter` in `RecognizePiiEntitiesOptions` is currently not working when used in `StartAnalyzeBatchActions`. [19237](https://github.com/Azure/azure-sdk-for-net/issues/19237).
29+
- `Statistics` for `AnalyzeBatchActionsResult` are not currently returned even if the user passes `IncludeStatistics = true`. [19268](https://github.com/Azure/azure-sdk-for-net/issues/19268).
30+
- `StartAnalyzeHealthcareEntities` is in gated preview and can not be used with AAD credentials. For more information, see [the Text Analytics for Health documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
31+
2732
## 5.1.0-beta.4 (2021-02-10)
2833
### New features
2934
- Added property `Length` to `CategorizedEntity`, `SentenceSentiment`, `LinkedEntityMatch`, `AspectSentiment`, `OpinionSentiment`, and `PiiEntity`.

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeBatchActionsResult.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,10 @@ internal AnalyzeBatchActionsResult(AnalyzeJobState jobState, IDictionary<string,
5656
public IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesActionsResults { get; }
5757

5858
/// <summary>
59-
/// <summary> if showStats=true was specified in the request this field will contain information about the document payload. </summary>
59+
/// Gets statistics about the operation executed and how it was processed
60+
/// by the service. This property currently won't return a value even if
61+
/// <see cref="AnalyzeBatchActionsOptions.IncludeStatistics"/> is set to true.
62+
/// More information https://github.com/Azure/azure-sdk-for-net/issues/19268
6063
/// </summary>
6164
public TextDocumentBatchStatistics Statistics { get; }
6265
}

sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,32 @@
55

66
namespace Azure.AI.TextAnalytics
77
{
8-
/// <summary> Determines the list of actions to be passed as arguments for AnalyzeBatchActionsOperation class. </summary>
8+
/// <summary> Determines the set of actions that will get executed on the input documents.</summary>
99
public class TextAnalyticsActions
1010
{
1111
/// <summary>
12-
/// DisplayName
12+
/// Optional display name for the analysis operation.
1313
/// </summary>
1414
public string DisplayName { get; set; }
1515

1616
/// <summary>
17-
/// ExtractKeyPhrasesOptions
17+
/// Extract KeyPhrases actions configurations.
1818
/// </summary>
1919
public IReadOnlyCollection<ExtractKeyPhrasesOptions> ExtractKeyPhrasesOptions { get; set; }
2020

2121
/// <summary>
22-
/// RecognizeEntitiesOptions
22+
/// Recognize Entities actions configurations.
2323
/// </summary>
2424
public IReadOnlyCollection<RecognizeEntitiesOptions> RecognizeEntitiesOptions { get; set; }
2525

2626
/// <summary>
27-
/// RecognizePiiEntityOptions
27+
/// Recognize PII Entities actions configurations.
28+
/// Note: `CategoriesFilters` will not have an effect on the action. See https://github.com/Azure/azure-sdk-for-net/issues/19237
2829
/// </summary>
2930
public IReadOnlyCollection<RecognizePiiEntitiesOptions> RecognizePiiEntitiesOptions { get; set; }
3031

3132
/// <summary>
32-
/// RecognizeLinkedEntitiesOptions
33+
/// Recognize Linked Entities actions configurations.
3334
/// </summary>
3435
public IReadOnlyCollection<RecognizeLinkedEntitiesOptions> RecognizeLinkedEntitiesOptions { get; set; }
3536
}

0 commit comments

Comments
 (0)