Skip to content

Commit

Permalink
[TA] Update changelog (#18580)
Browse files Browse the repository at this point in the history
Fixes: #18563
  • Loading branch information
maririos authored Feb 9, 2021
1 parent ba904d4 commit 2f0cae2
Showing 1 changed file with 28 additions and 9 deletions.
37 changes: 28 additions & 9 deletions sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,41 @@
# 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.
- `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`.

### 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
Expand Down

0 comments on commit 2f0cae2

Please sign in to comment.