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] Improve readme content #22792

Merged
merged 3 commits into from
Jul 6, 2021
Merged

[TA] Improve readme content #22792

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
923be2c
improve readme doc
mssfang Jul 6, 2021
de1d0e3
address feedbacks
mssfang Jul 6, 2021
30a7849
Merge branch 'main' of https://github.com/Azure/azure-sdk-for-java in…
mssfang Jul 6, 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
5 changes: 3 additions & 2 deletions sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Release History

## 5.1.0 (Unreleased)
## 5.1.0 (2021-07-08)
#### Feature Added
- We are now targeting the service's v3.1 API as the default instead of v3.1-preview.4.
- Added a new class, `HealthcareEntityCategory` to replace the `String` type of property `category` in the `HealthcareEntity`.
- Added the new types, `ExtractKeyPhrasesAction`, `RecognizeEntitiesAction`, `RecognizePiiEntitiesAction`,
`RecognizeLinkedEntitiesAction`, and `AnalyzeSentimentAction`.
- Added new customized `***PagedFlux`, `***PagedIterable` types, `AnalyzeActionsResultPagedFlux`,
`AnalyzeActionsResultPagedIterable`, `AnalyzeHealthcareEntitiesPagedFlux`, and `AnalyzeHealthcareEntitiesPagedIterable`.

- `beginAnalyzeHealthcareEntities` now works with Azure Active Directory credentials.

### Breaking Changes
- Changed behavior in `beginAnalyzeActions` API where now accepts up to one action only per action type.
An `IllegalArgumentException` is raised if multiple actions of the same type are passed.
Expand Down
48 changes: 28 additions & 20 deletions sdk/textanalytics/azure-ai-textanalytics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and includes six main functions:
- Language Detection
- Key Phrase Extraction
- Named Entity Recognition
- Personally Identifiable Information Entity Recognition
- Personally Identifiable Information (PII) Entity Recognition
- Linked Entity Recognition
- Healthcare Entity Recognition
- Multiple Actions Analysis Per Document
Expand All @@ -20,6 +20,26 @@ and includes six main functions:
- [Azure Subscription][azure_subscription]
- [Cognitive Services or Text Analytics account][text_analytics_account] to use this package.

### Include the Package

[//]: # ({x-version-update-start;com.azure:azure-ai-textanalytics;current})
```xml
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-textanalytics</artifactId>
<version>5.1.0</version>
</dependency>
```
[//]: # ({x-version-update-end})
**Note:** This version of the client library defaults to the `v3.1` version of the service.

This table shows the relationship between SDK services and supported API versions of the service:

|SDK version|Supported API version of service
|-|-
|5.1.x | 3.0, 3.1 (default)
mssfang marked this conversation as resolved.
Show resolved Hide resolved
|5.0.x | 3.0

#### Create a Cognitive Services or Text Analytics resource
Text Analytics supports both [multi-service and single-service access][service_access]. Create a Cognitive Services
resource if you plan to access multiple cognitive services under a single endpoint/key. For Text Analytics access only,
Expand All @@ -36,32 +56,20 @@ Below is an example of how you can create a Text Analytics resource using the CL
```bash
# Create a new resource group to hold the text analytics resource -
# if using an existing resource group, skip this step
az group create --name my-resource-group --location westus2
az group create --name <your-resource-group> --location <location>
```

```bash
# Create text analytics
az cognitiveservices account create \
--name text-analytics-resource \
--resource-group my-resource-group \
--name <your-resource-name> \
--resource-group <your-resource-group-name> \
--kind TextAnalytics \
--sku F0 \
--location westus2 \
--sku <sku> \
--location <location> \
--yes
```

### Include the Package
**Note:** This version targets Azure Text Analytics service API version v3.0.

[//]: # ({x-version-update-start;com.azure:azure-ai-textanalytics;current})
```xml
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-textanalytics</artifactId>
<version>5.1.0</version>
</dependency>
```
[//]: # ({x-version-update-end})
For more information about creating the resource or how to get the location and sku information see [here][azure_cli]

### Authenticate the client
In order to interact with the Text Analytics service, you will need to create an instance of the Text Analytics client,
Expand Down Expand Up @@ -371,7 +379,7 @@ syncPoller.getFinalResult().forEach(
### Analyze multiple actions
The `Analyze` functionality allows to choose which of the supported Text Analytics features to execute in the same
set of documents. Currently, the supported features are: `entity recognition`, `linked entity recognition`,
`key phrase extraction`, and `Personally Identifiable Information (PII) recognition`.
`Personally Identifiable Information (PII) entity recognition`, `key phrase extraction`, and `sentiment analysis`.
<!-- embedme ./src/samples/java/com/azure/ai/textanalytics/ReadmeSamples.java#L243-L291 -->
```java
List<TextDocumentInput> documents = Arrays.asList(
Expand Down