[AutoPR cognitiveservices/data-plane/TextAnalytics] updated model names in preview version to be consistent with stable version to avoid breaking changes in client side code

lib/services/cognitiveServicesTextAnalytics/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Microsoft
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2018 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lib/services/cognitiveServicesTextAnalytics/lib/models/entityRecord.js

@@ -28,6 +28,9 @@ class EntityRecord {
    * @member {string} [bingId] Bing unique identifier of the recognized entity.
    * Use in conjunction with the Bing Entity Search API to fetch additional
    * relevant information.
+   * @member {string} [type] Entity type from Named Entity Recognition model
+   * @member {string} [subType] Entity sub type from Named Entity Recognition
+   * model
    */
   constructor() {
   }
@@ -55,7 +58,6 @@ class EntityRecord {
           },
           matches: {
             required: false,
-            readOnly: true,
             serializedName: 'matches',
             type: {
               name: 'Sequence',
@@ -97,6 +99,20 @@ class EntityRecord {
             type: {
               name: 'String'
             }
+          },
+          type: {
+            required: false,
+            serializedName: 'type',
+            type: {
+              name: 'String'
+            }
+          },
+          subType: {
+            required: false,
+            serializedName: 'subType',
+            type: {
+              name: 'String'
+            }
           }
         }
       }

lib/services/cognitiveServicesTextAnalytics/lib/models/index.d.ts

@@ -227,14 +227,19 @@ export interface MatchRecord {
  * @member {string} [bingId] Bing unique identifier of the recognized entity.
  * Use in conjunction with the Bing Entity Search API to fetch additional
  * relevant information.
+ * @member {string} [type] Entity type from Named Entity Recognition model
+ * @member {string} [subType] Entity sub type from Named Entity Recognition
+ * model
  */
 export interface EntityRecord {
   name?: string;
-  readonly matches?: MatchRecord[];
+  matches?: MatchRecord[];
   wikipediaLanguage?: string;
   wikipediaId?: string;
   readonly wikipediaUrl?: string;
   bingId?: string;
+  type?: string;
+  subType?: string;
 }
 
 /**

lib/services/cognitiveServicesTextAnalytics/lib/textAnalyticsClient.d.ts

@@ -254,9 +254,21 @@ export default class TextAnalyticsClient extends ServiceClient {
   /**
    * @summary The API returns a list of recognized entities in a given document.
    *
-   * To get even more information on each recognized entity we recommend using
-   * the Bing Entity Search API by querying for the recognized entities names.
-   * See the <a
+   * The API returns a list of recognized entities in a given document. To get
+   * even more information on each recognized entity we recommend using the Bing
+   * Entity Search API by querying for the recognized entities names. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
+   * languages in Text Analytics API</a> for the list of enabled languages.The
+   * API returns a list of known entities and general named entities ("Person",
+   * "Location", "Organization" etc) in a given document. Known entities are
+   * returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be
+   * used in Bing Entity Search API. General named entities are returned with
+   * entity types. If a general named entity is also a known entity, then all
+   * information regarding it (Wikipedia Id, Bing Id, entity type etc) will be
+   * returned. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported
+   * Entity Types in Text Analytics API</a> for the list of supported Entity
+   * Types. See the <a
    * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
    * languages in Text Analytics API</a> for the list of enabled languages.
    *
@@ -280,9 +292,21 @@ export default class TextAnalyticsClient extends ServiceClient {
   /**
    * @summary The API returns a list of recognized entities in a given document.
    *
-   * To get even more information on each recognized entity we recommend using
-   * the Bing Entity Search API by querying for the recognized entities names.
-   * See the <a
+   * The API returns a list of recognized entities in a given document. To get
+   * even more information on each recognized entity we recommend using the Bing
+   * Entity Search API by querying for the recognized entities names. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
+   * languages in Text Analytics API</a> for the list of enabled languages.The
+   * API returns a list of known entities and general named entities ("Person",
+   * "Location", "Organization" etc) in a given document. Known entities are
+   * returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be
+   * used in Bing Entity Search API. General named entities are returned with
+   * entity types. If a general named entity is also a known entity, then all
+   * information regarding it (Wikipedia Id, Bing Id, entity type etc) will be
+   * returned. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported
+   * Entity Types in Text Analytics API</a> for the list of supported Entity
+   * Types. See the <a
    * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
    * languages in Text Analytics API</a> for the list of enabled languages.
    *

lib/services/cognitiveServicesTextAnalytics/lib/textAnalyticsClient.js

@@ -456,9 +456,21 @@ function _sentiment(input, options, callback) {
 /**
  * @summary The API returns a list of recognized entities in a given document.
  *
- * To get even more information on each recognized entity we recommend using
- * the Bing Entity Search API by querying for the recognized entities names.
- * See the <a
+ * The API returns a list of recognized entities in a given document. To get
+ * even more information on each recognized entity we recommend using the Bing
+ * Entity Search API by querying for the recognized entities names. See the <a
+ * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
+ * languages in Text Analytics API</a> for the list of enabled languages.The
+ * API returns a list of known entities and general named entities ("Person",
+ * "Location", "Organization" etc) in a given document. Known entities are
+ * returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be
+ * used in Bing Entity Search API. General named entities are returned with
+ * entity types. If a general named entity is also a known entity, then all
+ * information regarding it (Wikipedia Id, Bing Id, entity type etc) will be
+ * returned. See the <a
+ * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported
+ * Entity Types in Text Analytics API</a> for the list of supported Entity
+ * Types. See the <a
  * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
  * languages in Text Analytics API</a> for the list of enabled languages.
  *
@@ -621,7 +633,7 @@ class TextAnalyticsClient extends ServiceClient {
 
     super(credentials, options);
 
-    this.baseUri = '{Endpoint}/text/analytics/v2.0';
+    this.baseUri = '{Endpoint}/text/analytics/v2.1-preview';
     this.credentials = credentials;
     this.endpoint = endpoint;
 
@@ -932,9 +944,21 @@ class TextAnalyticsClient extends ServiceClient {
   /**
    * @summary The API returns a list of recognized entities in a given document.
    *
-   * To get even more information on each recognized entity we recommend using
-   * the Bing Entity Search API by querying for the recognized entities names.
-   * See the <a
+   * The API returns a list of recognized entities in a given document. To get
+   * even more information on each recognized entity we recommend using the Bing
+   * Entity Search API by querying for the recognized entities names. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
+   * languages in Text Analytics API</a> for the list of enabled languages.The
+   * API returns a list of known entities and general named entities ("Person",
+   * "Location", "Organization" etc) in a given document. Known entities are
+   * returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be
+   * used in Bing Entity Search API. General named entities are returned with
+   * entity types. If a general named entity is also a known entity, then all
+   * information regarding it (Wikipedia Id, Bing Id, entity type etc) will be
+   * returned. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported
+   * Entity Types in Text Analytics API</a> for the list of supported Entity
+   * Types. See the <a
    * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
    * languages in Text Analytics API</a> for the list of enabled languages.
    *
@@ -970,9 +994,21 @@ class TextAnalyticsClient extends ServiceClient {
   /**
    * @summary The API returns a list of recognized entities in a given document.
    *
-   * To get even more information on each recognized entity we recommend using
-   * the Bing Entity Search API by querying for the recognized entities names.
-   * See the <a
+   * The API returns a list of recognized entities in a given document. To get
+   * even more information on each recognized entity we recommend using the Bing
+   * Entity Search API by querying for the recognized entities names. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
+   * languages in Text Analytics API</a> for the list of enabled languages.The
+   * API returns a list of known entities and general named entities ("Person",
+   * "Location", "Organization" etc) in a given document. Known entities are
+   * returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be
+   * used in Bing Entity Search API. General named entities are returned with
+   * entity types. If a general named entity is also a known entity, then all
+   * information regarding it (Wikipedia Id, Bing Id, entity type etc) will be
+   * returned. See the <a
+   * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-entity-linking#supported-types-for-named-entity-recognition">Supported
+   * Entity Types in Text Analytics API</a> for the list of supported Entity
+   * Types. See the <a
    * href="https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/text-analytics-supported-languages">Supported
    * languages in Text Analytics API</a> for the list of enabled languages.
    *