[Text Analytics] Convenience layer for healthcare and analyze features (Azure#13483)

* [Text Analytics] [3.1-preview.3 design] Exposing job's metadata as part of the poller state for LROs (Azure#13031)

* [Text Analytics] Adding job metadata to the healthcare poller

* [Text Analytics] Adding job metadata to the analyze poller

* address feedback in the api review

* address more feedback

* make beginAnalyze task arrays required

* address feedback

* [Text Analytics] Organize healthcare entities as nodes in a graph (Azure#13032)

* [Text Analytics] Organize healthcare entities as a graph

* address feedback

* [Text Analytics] Adds an option to control how lengths and offsets are calculated (Azure#13035)

* [Text Analytics] Expose string encoding parameter

* adding length back

* adding unit tests for the string encoding parameter

* fix export

* renaming and refactoring

* rename back to the service's name

* fixes

* address feedback

* address feedback

* update samples

* [Text Analytics] Address feedback from the arch board meeting 11/1 (Azure#13169)

* address feedback

* update sample

* update the name of the options type to beginAnalyzeHealthcareEntities

* [Text Analytics] Address additional feedback (Azure#13296)

* [Text Analytics] Address additional feedback

* fix build

* [Text Analytics] Implementing agreed-on renamings (Azure#13424)

* [Text Analytics] Implementing agreed-on renamings

* fix failures in CI, address feedback, and make one more renaming

* address feedback

* edit README

* address feedback

* address feedback

* move utils to public to fix min max testing

* this is needed for the test/public package created by minmax testing

* fix mapping

Author: deyaaeldeen

sdk/textanalytics/ai-text-analytics/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+## 5.1.0-beta.4 (unreleased)
+
+- [Breaking] `beginAnalyzeHealthcare` is renamed to `beginAnalyzeHealthcareEntities`.
+- [Breaking] `beginAnalyze` is renamed to `beginAnalyzeBatchActions`.
+- A new option to control how the offset is calculated by the service, `stringIndexType`, is added to `analyzeSentiment`, `recognizeEntities`, `recognizePiiEntities`, and `beginAnalyzeHealthcareEntities`. Furthermore, `stringIndexType` is added to task types `RecognizeEntitiesAction` and `RecognizePiiEntitiesAction`, which are the types of input actions to the `beginAnalyzeBatchActions` method. For more information, see [the Text Analytics documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/text-offsets#offsets-in-api-version-31-preview).
+- [Breaking] The healthcare entities returned by `beginAnalyzeHealthcare` 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.
+- [Breaking] The `links` property of `HealthcareEntity` is renamed to `dataSources`, a list of objects representing medical databases, where each object has `name` and `entityId` properties.
+- The poller for the `beginAnalyzeBatchActions` long-running operation gained the ability to return certain metadata information about the currently running operation (e.g., when the operation was created, will be expired, and last time it was updated, and also how many actions completed and failed so far). Also, the poller for `beginAnalyzeHealthcareEntities` gained a similar ability.
+- [Breaking] the words "operation" and "action" are used consistently in our names and documentation instead of "job" and "task" respectively.
+
 ## 5.1.0-beta.3 (2020-11-23)
 
 - We are now targeting the service's v3.1-preview.3 API as the default instead of v3.1-preview.2.

sdk/textanalytics/ai-text-analytics/README.md

@@ -406,7 +406,7 @@ const documents = [
 ];
 
 async function main() {
-  const poller = await client.beginAnalyzeHealthcare(documents);
+  const poller = await client.beginAnalyzeHealthcareEntities(documents);
   const results = await poller.pollUntilDone();
 
   for await (const result of results) {
@@ -423,9 +423,9 @@ async function main() {
 main();
 ```
 
-### Analyze
+### Analyze Batch Actions
 
-Analyze enables the application of multiple analyses at once.
+Analyze batch actions enables the application of multiple analyses (named actions) at once.
 
 ```javascript
 const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
@@ -440,16 +440,16 @@ const documents = [
 ];
 
 async function main() {
-  const tasks = {
-    entityRecognitionTasks: [{ modelVersion: "latest" }],
-    entityRecognitionPiiTasks: [{ modelVersion: "latest" }],
-    keyPhraseExtractionTasks: [{ modelVersion: "latest" }]
+  const actions = {
+    recognizeEntitiesActions: [{ modelVersion: "latest" }],
+    recognizePiiEntitiesActions: [{ modelVersion: "latest" }],
+    extractKeyPhrasesActions: [{ modelVersion: "latest" }]
   };
-  const poller = await client.beginAnalyze(documents, tasks);
+  const poller = await client.beginAnalyzeBatchActions(documents, actions);
   const resultPages = await poller.pollUntilDone();
 
   for await (const page of resultPages) {
-    const keyPhrasesResults = page.keyPhrasesExtractionResults[0];
+    const keyPhrasesResults = page.extractKeyPhrasesResults[0];
     for (const doc of keyPhrasesResults) {
       console.log(`- Document ${doc.id}`);
       if (!doc.error) {
@@ -462,7 +462,7 @@ async function main() {
       }
     }
 
-    const entitiesResults = page.entitiesRecognitionResults[0];
+    const entitiesResults = page.recognizeEntitiesResults[0];
     for (const doc of entitiesResults) {
       console.log(`- Document ${doc.id}`);
       if (!doc.error) {
@@ -475,7 +475,7 @@ async function main() {
       }
     }
 
-    const piiEntitiesResults = page.piiEntitiesRecognitionResults[0];
+    const piiEntitiesResults = page.recognizePiiEntitiesResults[0];
     for (const doc of piiEntitiesResults) {
       console.log(`- Document ${doc.id}`);
       if (!doc.error) {

sdk/textanalytics/ai-text-analytics/package.json

@@ -48,7 +48,7 @@
   },
   "browser": {
     "./dist-esm/src/utils/url.js": "./dist-esm/src/utils/url.browser.js",
-    "./dist-esm/test/utils/env.js": "./dist-esm/test/utils/env.browser.js"
+    "./dist-esm/test/public/utils/env.js": "./dist-esm/test/public/utils/env.browser.js"
   },
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",