From de7f90c8dcb572eb8c7b1a79f7841d6310b9d683 Mon Sep 17 00:00:00 2001 From: Mariana Rios Flores Date: Mon, 8 Feb 2021 16:29:15 -0800 Subject: [PATCH 1/4] add missing descriptions --- .../Azure.AI.TextAnalytics/CHANGELOG.md | 35 ++++++++++++++----- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md index e6bd97b5d6090..3dcab960e3bc9 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md @@ -3,20 +3,39 @@ ## 5.1.0-beta.4 (Unreleased) ### New features - Added property `Length` to `CategorizedEntity`, `SentenceSentiment`, `LinkedEntityMatch`, `AspectSentiment`, `OpinionSentiment`, and `PiiEntity`. -- `StringIndexType` has been added to all endpoints as a new option to control how the `Offset` and `Length` are calculated by the service. +- `StringIndexType` has been added to all endpoints as a new option to control how the `Offset` and `Length` are calculated by the service. It is added into the `TextAnalyticsRequestOptions` class. +- `AnalyzeHealthcareEntitiesOperation` now exposes the properties `CreatedOn`, `ExpiresOn`, `LastModified`, and `Status`. +- `AnalyzeBatchActionsOperation ` now exposes the properties `CreatedOn`, `ExpiresOn`, `LastModified`, `Status`, `ActionsFailed`, `ActionsInProgress`, `ActionsSucceeded`, `DisplayName`, and `TotalActions`. ### Breaking changes +- Renamed `JobStatus` to `TextAnalyticsOperationStatus`. + +#### Analyze Healthcare Entities +- Pagination support was added for all `StartAnalyzeHealthcareEntities` methods. +- Moved `Cancel` and `CancelAsync` for Healthcare from `TextAnalyticsClient` to `AnalyzeHealthcareEntitiesOperation`. +- The healthcare entities returned by `StartAnalyzeHealthcareEntities` are now organized as a directed graph where the edges represent a certain type of healthcare relationship between the source and target entities. Edges are stored in the `RelatedEntities` property. +- Renamed `StartHealthcareBatch` and `StartHealthcareBatchAsync` to `StartAnalyzeHealthcareEntities` and `StartAnalyzeHealthcareEntitiesAsync` respectively. - Renamed `RecognizeHealthcareEntitiesResultCollection` to `AnalyzeHealthcareEntitiesResultCollection`. - Renamed `DocumentHealthcareResult` to `AnalyzeHealthcareEntitiesResult`. -- Removed `StartHealthcare` and `StartHealthcareAsync` methods. -- Renamed `StartHealthcareBatch` and `StartHealthcareBatchAsync` to `StartAnalyzeHealthcareEntities` and `StartAnalyzeHealthcareEntitiesAsync` respectively. - Renamed `HealthcareOperation` to `AnalyzeHealthcareEntitiesOperation`. -- Renamed `HealthcareOptions` to `AnalyzeHealthcareEntitiesOptions`. -- Moved `Cancel` and `CancelAsync` for Healthcare from `TextAnalyticsClient` to `AnalyzeHealthcareEntitiesOperation`. -- Renamed `JobStatus` to `TextAnalyticsOperationStatus`. +- Renamed `HealthcareOptions` to `AnalyzeHealthcareEntitiesOptions`, and removed types `Skip` and `Top` from it. Pagination is now done automatically by the SDK. - Renamed `HealthcareEntityLink` to `EntityDataSource` with `DataSource` to `EntityDataSource` and `Id` to `Name`. -- Removed `HealthcareRelation` and added `HealthcareRelationType`. - +- Renamed `HealthcareRelation` to `HealthcareRelationType`. +- Removed method `GetHealthcareEntities` as pagination is now done with the main `StartAnalyzeHealthcareEntities` methods. +- Removed `HealthcareTaskResult`. +- Removed `StartHealthcare` and `StartHealthcareAsync` methods. +- Removed `IsNegated` property from `HealthcareEntity`. + +#### Analyze batch actions +- The word `action` is now used consistently in our names and documentation instead of `task`. +- Pagination support was added for all `StartAnalyzeBatchActions` methods. +- Renamed methods `StartAnalyzeOperationBatch` and `StartAnalyzeOperationBatchAsync` to `StartAnalyzeBatchActions` and `StartAnalyzeBatchActionsAsync` respectively. +- Type `TextAnalyticsActions` added to `StartAnalyzeBatchActions` methods to specify the actions to execute in the batch of documents instead of in `AnalyzeOperationOptions`. +- The way to configure the options for each action is now exposed in the respective `ExtractKeyPhrasesOptions`, `RecognizeEntitiesOptions`, or `RecognizePiiEntitiesOptions` object. +- Results for the `StartAnalyzeBatchActions` method are now returned in a `AnalyzeHealthcareEntitiesResultCollection` object that contains information per type of action. +- Renamed `AnalyzeOperation` to `AnalyzeBatchActionsOperation`. +- Reuse `PiiEntityDomainType` instead of `PiiTaskParametersDomain`. +- Removed `AnalyzeTasks`, `EntitiesTask`, `EntitiesTaskParameters`, `EntityRecognitionTasksItem`, `JobManifestTasks`, `KeyPhraseExtractionTasksItem`, `KeyPhrasesTask`, `KeyPhrasesTaskParameters`, `PiiTask`, `PiiTaskParameters`, ## 5.1.0-beta.3 (2020-11-19) ### New Features From a0abb7982deb6b831b9adbe799346ae25e1d33c5 Mon Sep 17 00:00:00 2001 From: Mariana Rios Flores Date: Mon, 8 Feb 2021 17:58:52 -0800 Subject: [PATCH 2/4] add date --- sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md index 3dcab960e3bc9..c577fefcd0c99 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 5.1.0-beta.4 (Unreleased) +## 5.1.0-beta.4 (2021-02-10) ### New features - Added property `Length` to `CategorizedEntity`, `SentenceSentiment`, `LinkedEntityMatch`, `AspectSentiment`, `OpinionSentiment`, and `PiiEntity`. - `StringIndexType` has been added to all endpoints as a new option to control how the `Offset` and `Length` are calculated by the service. It is added into the `TextAnalyticsRequestOptions` class. From 15e69ab60065f2494df7e842542be567bc7c3465 Mon Sep 17 00:00:00 2001 From: Mariana Rios Flores Date: Tue, 9 Feb 2021 10:14:03 -0800 Subject: [PATCH 3/4] update stringindextype --- sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md index c577fefcd0c99..eb2250837dcdc 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md @@ -3,7 +3,7 @@ ## 5.1.0-beta.4 (2021-02-10) ### New features - Added property `Length` to `CategorizedEntity`, `SentenceSentiment`, `LinkedEntityMatch`, `AspectSentiment`, `OpinionSentiment`, and `PiiEntity`. -- `StringIndexType` has been added to all endpoints as a new option to control how the `Offset` and `Length` are calculated by the service. It is added into the `TextAnalyticsRequestOptions` class. +- `StringIndexType` has been added to all endpoints that expose the new properties `Offset` and `Length` to determine the endoding the service should use. It is added into the `TextAnalyticsRequestOptions` class and default for this SDK is `UTF-16`. - `AnalyzeHealthcareEntitiesOperation` now exposes the properties `CreatedOn`, `ExpiresOn`, `LastModified`, and `Status`. - `AnalyzeBatchActionsOperation ` now exposes the properties `CreatedOn`, `ExpiresOn`, `LastModified`, `Status`, `ActionsFailed`, `ActionsInProgress`, `ActionsSucceeded`, `DisplayName`, and `TotalActions`. From 527fa9295273f7149b1d60489916f5692c9a79a7 Mon Sep 17 00:00:00 2001 From: Mariana Rios Flores Date: Tue, 9 Feb 2021 10:15:17 -0800 Subject: [PATCH 4/4] remove extra comma --- sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md index eb2250837dcdc..12d806af64cca 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md @@ -35,7 +35,7 @@ - Results for the `StartAnalyzeBatchActions` method are now returned in a `AnalyzeHealthcareEntitiesResultCollection` object that contains information per type of action. - Renamed `AnalyzeOperation` to `AnalyzeBatchActionsOperation`. - Reuse `PiiEntityDomainType` instead of `PiiTaskParametersDomain`. -- Removed `AnalyzeTasks`, `EntitiesTask`, `EntitiesTaskParameters`, `EntityRecognitionTasksItem`, `JobManifestTasks`, `KeyPhraseExtractionTasksItem`, `KeyPhrasesTask`, `KeyPhrasesTaskParameters`, `PiiTask`, `PiiTaskParameters`, +- Removed `AnalyzeTasks`, `EntitiesTask`, `EntitiesTaskParameters`, `EntityRecognitionTasksItem`, `JobManifestTasks`, `KeyPhraseExtractionTasksItem`, `KeyPhrasesTask`, `KeyPhrasesTaskParameters`, `PiiTask`, `PiiTaskParameters`. ## 5.1.0-beta.3 (2020-11-19) ### New Features