[TextAnalytics] Implement Recognize Custom Entities API

[kinelski]

Issue

We must implement the new Recognize Custom Entities API following the design presented in: apiview

This new feature will be added as one of the actions in the Analyze API.

Usage example:

var documents = new List<string>() { "There are so many ways of arranging a deck of cards that, after shuffling it, it's almost guaranteed that the resulting sequence of cards has never appeared in the history of humanity." }

TextAnalyticsActions actions = new TextAnalyticsActions()
{
    RecognizeCustomEntitiesActions =
    {
        new RecognizeCustomEntitiesAction("<project-name>", "<deployment-name>")
    }
};

AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(documents, actions);

await operation.WaitForCompletionAsync();

AnalyzeActionsResult actionsResult = operation.Value;
IReadOnlyCollection<RecognizeCustomEntitiesActionResult> results = actionsResult.RecognizeCustomEntitiesResults;

Goals

Note: it's strongly recommended to use the already implemented Extractive Summarization API as a reference. It's also part of the Analyze API, and the general structures of models/tests/samples are the same.

Implementation

• Make sure the generated code is up to date with the latest swagger file.
• Add new models/properties and their implementations.

Tests

Note: currently we're still waiting for the service team to provide a resource we can use for testing, so live testing cannot be accomplished until then.

For each one of the tasks below, a "reference" test has been added so it can be used as a guide during implementation. The general structure of the suggested reference tests are very similar to the ones we want to implement.

• Add live tests for the new Recognize Custom Entities API. Reference test class: ExtractSummaryTests.

• Add new tests in AnalyzeMockTests:

  • Assert loggingOptOut JSON property is sent when using RecognizeCustomEntitiesAction.DisableServiceLogs. Reference test: AnalyzeOperationExtractSummaryWithDisableServiceLogs.
  • Assert that sending two RecognizeCustomEntitiesAction in the same request throws an ArgumentException. Reference test: AnalyzeOperationExtractSummaryWithTwoActions.

• Update existing tests in AnalyzeMockTests:

  • Modify AnalyzeOperationWithActionsError to include the new task used in the Recognize Custom Entities API.

• Update existing tests in AnalyzeOperationTests:

  • Modify AnalyzeOperationTest to include the new RecognizeCustomEntitiesAction.

Documentation and Samples

• Add a new sample for the Recognize Custom Entities API.
• Consider adding a new section to the README as well to illustrate the usage of the new API.
• Update changelogs.