[Text Analytics] Updates/Renames for Custom Text and language

In the context of Custom Text (models, method names, samples, docs, etc), the service team requested the following renames:

1. Category (as in machine learning class/label and not to be confused with entity category) to Label
2. Custom Entity to Custom Named Entity
3. Any prefixes/postfixes to projectName and deploymentName to be dropped. For instance CUSTOM_ENTITIES_PROJECT_NAME should be renamed to projectName
4. subCategory shouldn’t be part of the returned custom named entity structures/classes.

In the context of references to the service:

1. Text Analytics should be renamed to Language
2. References to the API key (e.g. AZURE_TEXT_ANALYTICS_KEY or apiKey) should be renamed to Azure Language key

The original request is documented in https://microsoft.sharepoint.com/:x:/t/luis_core/EabmFH8uAk1Jry2cY6Ug1qEB4APAE1x-uXm73uJy7rmitA?e=QWcHYm

[deyaaeldeen]

@jsquire Here is a list of things that are proposed to be changed:

Category => Label

• TextAnalyticsActions.SingleCategoryClassifyActions => TextAnalyticsActions.SingleLabelClassifyActions
• SingleCategoryClassifyAction => SingleLabelClassifyAction
• SingleCategoryClassifyActionResult => SingleLabelClassifyActionResult
• SingleCategoryClassifyResult => SingleLabelClassifyResult
• SingleCategoryClassifyResultCollection => SingleLabelClassifyResultCollection
• AnalyzeActionsResult.SingleCategoryClassifyResults => AnalyzeActionsResult.SingleLabelClassifyResults

Please apply the same renaming to the corresponding names for the MultiCategory variant.

Custom Entity => Custom Named Entity*

• AnalyzeActionsResult.RecognizeCustomEntitiesResults => AnalyzeActionsResult.RecognizeCustomNamedEntitiesResults

• RecognizeCustomEntitiesActionResult => RecognizeCustomNamedEntitiesActionResult

• RecognizeCustomEntitiesResultCollection => RecognizeCustomNamedEntitiesResultCollection

• TextAnalyticsActions.RecognizeCustomEntitiesActions => RecognizeCustomNamedEntitiesActions

• RecognizeCustomEntitiesAction => RecognizeCustomNamedEntitiesAction

Dropping subCategory from Custom Named Entities results*

It currently inherits from the standard entity results type which has a subCategory field and the ask here is to use a model that does not have subCategory in it.

Others

The rest of the proposal are mainly terminology and variable name changes.

Please talk to your architects about those changes, especially the ones with the * since one will make a long name even longer and the other will introduce new models that share most of its members with a current one.

I hope that helps!

[deyaaeldeen]

These renames have been adopted by the swagger for v2022-04-01-preview and v6.0.0-beta.1 is following that swagger closely so I believe this issue has been addressed for JS.