Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[TA] Update changelog #18580

Merged
4 commits merged into from
Feb 9, 2021
Merged

[TA] Update changelog #18580

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de7f90c
add missing descriptions
maririos Feb 9, 2021
a0abb79
add date
maririos Feb 9, 2021
15e69ab
update stringindextype
maririos Feb 9, 2021
527fa92
remove extra comma
maririos Feb 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 28 additions & 9 deletions sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md
View file
Open in desktop
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 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
Expand Down