[Text Analytics] Added entity linking tasks to analyze operation (Azure#19168)

# All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.
- [ ] **Please open PR in `Draft` mode if it is:**
	- Work in progress or not intended to be merged.
	- Encountering multiple pipeline failures and working on fixes.
- [ ] If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md).**
- [ ] **The pull request does not introduce [breaking changes](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md).**

### [General Guidelines and Best Practices](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#general-guidelines)
- [ ] Title of the pull request is clear and informative.
- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md).

### [Testing Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#testing-guidelines)
- [ ] Pull request includes test coverage for the included changes.

### [SDK Generation Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#sdk-generation-guidelines)
- [ ] The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
- [ ] The `*.csproj` and `AssemblyInfo.cs` files have been updated with the new version of the SDK. Please double check nuget.org current release version.

## Additional management plane SDK specific contribution checklist: 
Note: Only applies to `Microsoft.Azure.Management.[RP]` or `Azure.ResourceManager.[RP]`
 
- [ ] Include updated [management metadata](https://github.com/Azure/azure-sdk-for-net/tree/master/eng/mgmt/mgmtmetadata).
- [ ] Update AzureRP.props to add/remove version info to maintain up to date API versions.

### Management plane SDK Troubleshooting
- If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add `new service` label and/or contact assigned reviewer.
- If the check fails at the `Verify Code Generation` step, please ensure:
	- Do not modify any code in generated folders.
	- Do not selectively include/remove generated files in the PR.
	- Do use `generate.ps1/cmd` to generate this PR instead of calling `autorest` directly.
	Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version,

### Old outstanding PR cleanup
 Please note:
	If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

Author: suhas92

sdk/textanalytics/Azure.AI.TextAnalytics/CHANGELOG.md

@@ -3,6 +3,9 @@
 ## 5.1.0-beta.5 (Unreleased)
 ### New features
 - Added ability to filter the categories returned in a Personally Identifiable Information recognition with the optional parameter `CategoriesFilter` in `RecognizePiiEntitiesOptions`.
+- Added the ability to recognize linked entities under `StartAnalyzeBatchActions`.
+- Added `RecognizeLinkedEntitiesOptions` to `TextAnalyticsActions`.
+- Added `RecognizeLinkedEntitiesActionsResults` to `AnalyzeBatchActionsResult`.
 - `AnalyzeHealthcareEntitiesResult`, now exposes the property `EntityRelations`of type `HealthcareEntityRelation`.
 - Introduced `HealthcareEntityRelation` class which will determine all the different relations between the entities as `Roles`.
 - Added `HealthcareEntityRelationRole`, which exposes `Name` and `Entity` of type `string` and `HealthcareEntity` respectively.

sdk/textanalytics/Azure.AI.TextAnalytics/README.md

@@ -494,7 +494,7 @@ Text Analytics for health is a containerized service that extracts and labels re
 ```
 
 ### Run Analyze Operation Asynchronously
-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, key phrase extraction, and Personally Identifiable Information (PII) Recognition. For more information see [How to: Use Text Analytics for analyze operation][analyze_operation_howto].
+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. For more information see [How to: Use Text Analytics for analyze operation][analyze_operation_howto].
 
 ```C# Snippet:AnalyzeOperationBatchConvenienceAsync
     string documentA = @"We love this trail and make the trip every year. The views are breathtaking and well
@@ -526,6 +526,7 @@ The Analyze functionality allows to choose which of the supported Text Analytics
         ExtractKeyPhrasesOptions = new List<ExtractKeyPhrasesOptions>() { new ExtractKeyPhrasesOptions() },
         RecognizeEntitiesOptions = new List<RecognizeEntitiesOptions>() { new RecognizeEntitiesOptions() },
         RecognizePiiEntitiesOptions = new List<RecognizePiiEntitiesOptions>() { new RecognizePiiEntitiesOptions() },
+        RecognizeLinkedEntitiesOptions = new List<RecognizeLinkedEntitiesOptions>() { new RecognizeLinkedEntitiesOptions() },
         DisplayName = "AnalyzeOperationSample"
     };
 
@@ -541,6 +542,8 @@ The Analyze functionality allows to choose which of the supported Text Analytics
 
         RecognizePiiEntitiesResultCollection piiResult = documentsInPage.RecognizePiiEntitiesActionsResults.FirstOrDefault().Result;
 
+        RecognizeLinkedEntitiesResultCollection elResult = documentsInPage.RecognizeLinkedEntitiesActionsResults.FirstOrDefault().Result;
+
         Console.WriteLine("Recognized Entities");
 
         foreach (RecognizeEntitiesResult result in entitiesResult)
@@ -587,6 +590,33 @@ The Analyze functionality allows to choose which of the supported Text Analytics
             }
             Console.WriteLine("");
         }
+
+        Console.WriteLine("Recognized Linked Entities");
+
+        foreach (RecognizeLinkedEntitiesResult result in elResult)
+        {
+            Console.WriteLine($"    Recognized the following {result.Entities.Count} linked entities:");
+
+            foreach (LinkedEntity entity in result.Entities)
+            {
+                Console.WriteLine($"    Entity: {entity.Name}");
+                Console.WriteLine($"    DataSource: {entity.DataSource}");
+                Console.WriteLine($"    DataSource EntityId: {entity.DataSourceEntityId}");
+                Console.WriteLine($"    Language: {entity.Language}");
+                Console.WriteLine($"    DataSource Url: {entity.Url}");
+
+                Console.WriteLine($"    Total Matches: {entity.Matches.Count()}");
+                foreach (LinkedEntityMatch match in entity.Matches)
+                {
+                    Console.WriteLine($"        Match Text: {match.Text}");
+                    Console.WriteLine($"        ConfidenceScore: {match.ConfidenceScore}");
+                    Console.WriteLine($"        Offset: {match.Offset}");
+                    Console.WriteLine($"        Length: {match.Length}");
+                }
+                Console.WriteLine("");
+            }
+            Console.WriteLine("");
+        }
     }
 }
 ```

sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs

@@ -34,6 +34,7 @@ public partial class AnalyzeBatchActionsResult
         internal AnalyzeBatchActionsResult() { }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult> ExtractKeyPhrasesActionsResults { get { throw null; } }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeEntitiesActionResult> RecognizeEntitiesActionsResults { get { throw null; } }
+        public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesActionsResults { get { throw null; } }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizePiiEntitiesActionResult> RecognizePiiEntitiesActionsResults { get { throw null; } }
         public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } }
     }
@@ -569,6 +570,15 @@ internal RecognizeEntitiesResultCollection() : base (default(System.Collections.
         public string ModelVersion { get { throw null; } }
         public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } }
     }
+    public partial class RecognizeLinkedEntitiesActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionDetails
+    {
+        internal RecognizeLinkedEntitiesActionResult() { }
+        public Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection Result { get { throw null; } }
+    }
+    public partial class RecognizeLinkedEntitiesOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions
+    {
+        public RecognizeLinkedEntitiesOptions() { }
+    }
     public partial class RecognizeLinkedEntitiesResult : Azure.AI.TextAnalytics.TextAnalyticsResult
     {
         internal RecognizeLinkedEntitiesResult() { }
@@ -672,6 +682,7 @@ public TextAnalyticsActions() { }
         public string DisplayName { get { throw null; } set { } }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.ExtractKeyPhrasesOptions> ExtractKeyPhrasesOptions { get { throw null; } set { } }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeEntitiesOptions> RecognizeEntitiesOptions { get { throw null; } set { } }
+        public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesOptions> RecognizeLinkedEntitiesOptions { get { throw null; } set { } }
         public System.Collections.Generic.IReadOnlyCollection<Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions> RecognizePiiEntitiesOptions { get { throw null; } set { } }
     }
     public partial class TextAnalyticsClient

sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample_AnalyzeBatchActions.md

@@ -47,6 +47,7 @@ To run analyze operation in multiple documents, call `StartAnalyzeOperationBatch
         ExtractKeyPhrasesOptions = new List<ExtractKeyPhrasesOptions>() { new ExtractKeyPhrasesOptions() },
         RecognizeEntitiesOptions = new List<RecognizeEntitiesOptions>() { new RecognizeEntitiesOptions() },
         RecognizePiiEntitiesOptions = new List<RecognizePiiEntitiesOptions>() { new RecognizePiiEntitiesOptions() },
+        RecognizeLinkedEntitiesOptions = new List<RecognizeLinkedEntitiesOptions>() { new RecognizeLinkedEntitiesOptions() },
         DisplayName = "AnalyzeOperationSample"
     };
 
@@ -62,6 +63,8 @@ To run analyze operation in multiple documents, call `StartAnalyzeOperationBatch
 
         RecognizePiiEntitiesResultCollection piiResult = documentsInPage.RecognizePiiEntitiesActionsResults.FirstOrDefault().Result;
 
+        RecognizeLinkedEntitiesResultCollection elResult = documentsInPage.RecognizeLinkedEntitiesActionsResults.FirstOrDefault().Result;
+
         Console.WriteLine("Recognized Entities");
 
         foreach (RecognizeEntitiesResult result in entitiesResult)
@@ -108,6 +111,33 @@ To run analyze operation in multiple documents, call `StartAnalyzeOperationBatch
             }
             Console.WriteLine("");
         }
+
+        Console.WriteLine("Recognized Linked Entities");
+
+        foreach (RecognizeLinkedEntitiesResult result in elResult)
+        {
+            Console.WriteLine($"    Recognized the following {result.Entities.Count} linked entities:");
+
+            foreach (LinkedEntity entity in result.Entities)
+            {
+                Console.WriteLine($"    Entity: {entity.Name}");
+                Console.WriteLine($"    DataSource: {entity.DataSource}");
+                Console.WriteLine($"    DataSource EntityId: {entity.DataSourceEntityId}");
+                Console.WriteLine($"    Language: {entity.Language}");
+                Console.WriteLine($"    DataSource Url: {entity.Url}");
+
+                Console.WriteLine($"    Total Matches: {entity.Matches.Count()}");
+                foreach (LinkedEntityMatch match in entity.Matches)
+                {
+                    Console.WriteLine($"        Match Text: {match.Text}");
+                    Console.WriteLine($"        ConfidenceScore: {match.ConfidenceScore}");
+                    Console.WriteLine($"        Offset: {match.Offset}");
+                    Console.WriteLine($"        Length: {match.Length}");
+                }
+                Console.WriteLine("");
+            }
+            Console.WriteLine("");
+        }
     }
 }
 ```

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeBatchActionsOperation.cs

@@ -262,7 +262,8 @@ private async ValueTask<Response> UpdateStatusAsync(bool async, CancellationToke
                     _actionSucceeded = update.Value.Tasks.Completed;
                     _totalActions = update.Value.Tasks.Total;
 
-                    if (update.Value.Status == TextAnalyticsOperationStatus.Succeeded || update.Value.Status == TextAnalyticsOperationStatus.PartiallySucceeded)
+                    // TODO - Remove PartiallySucceeded once service deploys this to WestUS2
+                    if (update.Value.Status == TextAnalyticsOperationStatus.Succeeded || update.Value.Status == TextAnalyticsOperationStatus.PartiallySucceeded || update.Value.Status == TextAnalyticsOperationStatus.PartiallyCompleted)
                     {
                         // we need to first assign a value and then mark the operation as completed to avoid race conditions
                         var nextLink = update.Value.NextLink;

sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeBatchActionsResult.cs

@@ -11,11 +11,17 @@ namespace Azure.AI.TextAnalytics
     /// </summary>
     public class AnalyzeBatchActionsResult
     {
-        internal AnalyzeBatchActionsResult(IReadOnlyCollection<ExtractKeyPhrasesActionResult> extractKeyPhrasesActionResult, IReadOnlyCollection<RecognizeEntitiesActionResult> recognizeEntitiesActionResults, IReadOnlyCollection<RecognizePiiEntitiesActionResult> recognizePiiEntitiesActionResults, TextDocumentBatchStatistics statistics)
+        internal AnalyzeBatchActionsResult(
+            IReadOnlyCollection<ExtractKeyPhrasesActionResult> extractKeyPhrasesActionResult,
+            IReadOnlyCollection<RecognizeEntitiesActionResult> recognizeEntitiesActionResults,
+            IReadOnlyCollection<RecognizePiiEntitiesActionResult> recognizePiiEntitiesActionResults,
+            IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> recognizeLinkedEntitiesActionsResults,
+            TextDocumentBatchStatistics statistics)
         {
             ExtractKeyPhrasesActionsResults = extractKeyPhrasesActionResult;
             RecognizeEntitiesActionsResults = recognizeEntitiesActionResults;
             RecognizePiiEntitiesActionsResults = recognizePiiEntitiesActionResults;
+            RecognizeLinkedEntitiesActionsResults = recognizeLinkedEntitiesActionsResults;
             Statistics = statistics;
         }
 
@@ -25,6 +31,7 @@ internal AnalyzeBatchActionsResult(AnalyzeJobState jobState, IDictionary<string,
             ExtractKeyPhrasesActionsResults = actionResults.ExtractKeyPhrasesActionsResults;
             RecognizeEntitiesActionsResults = actionResults.RecognizeEntitiesActionsResults;
             RecognizePiiEntitiesActionsResults = actionResults.RecognizePiiEntitiesActionsResults;
+            RecognizeLinkedEntitiesActionsResults = actionResults.RecognizeLinkedEntitiesActionsResults;
             Statistics = actionResults.Statistics;
         }
 
@@ -43,6 +50,11 @@ internal AnalyzeBatchActionsResult(AnalyzeJobState jobState, IDictionary<string,
         /// </summary>
         public IReadOnlyCollection<RecognizePiiEntitiesActionResult> RecognizePiiEntitiesActionsResults { get; }
 
+        /// <summary>
+        /// Determines the collection of RecognizeLinkedEntitiesActionsResult.
+        /// </summary>
+        public IReadOnlyCollection<RecognizeLinkedEntitiesActionResult> RecognizeLinkedEntitiesActionsResults { get; }
+
         /// <summary>
         /// <summary> if showStats=true was specified in the request this field will contain information about the document payload. </summary>
         /// </summary>

sdk/textanalytics/Azure.AI.TextAnalytics/src/EntityLinkingTaskParameters.cs

@@ -1,25 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using Azure.AI.TextAnalytics.Models;
 using Azure.Core;
 
-namespace Azure.AI.TextAnalytics
+namespace Azure.AI.TextAnalytics.Models
 {
     /// <summary>
     /// EntityLinkingTaskParameters class.
     /// </summary>
     [CodeGenModel("EntityLinkingTaskParameters")]
     internal partial class EntityLinkingTaskParameters
-    {
-        /// <summary>
-        /// ModelVersion
-        /// </summary>
-        public string ModelVersion { get; set; } = "latest";
-
-        /// <summary>
-        /// StringIndexType
-        /// </summary>
-        public StringIndexType StringIndexType { get; set; } = StringIndexType.Utf16CodeUnit;
-    }
+    { }
 }