diff --git a/packages/@azure/cognitiveservices-textanalytics/lib/models/index.ts b/packages/@azure/cognitiveservices-textanalytics/lib/models/index.ts index aad90e06e703..85e65327d742 100644 --- a/packages/@azure/cognitiveservices-textanalytics/lib/models/index.ts +++ b/packages/@azure/cognitiveservices-textanalytics/lib/models/index.ts @@ -295,10 +295,8 @@ export interface EntityRecord { /** * @member {MatchRecord[]} [matches] List of instances this entity appears in * the text. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** */ - readonly matches?: MatchRecord[]; + matches?: MatchRecord[]; /** * @member {string} [wikipediaLanguage] Wikipedia language for which the * WikipediaId and WikipediaUrl refers to. @@ -322,6 +320,15 @@ export interface EntityRecord { * relevant information. */ bingId?: string; + /** + * @member {string} [type] Entity type from Named Entity Recognition model + */ + type?: string; + /** + * @member {string} [subType] Entity sub type from Named Entity Recognition + * model + */ + subType?: string; } /** diff --git a/packages/@azure/cognitiveservices-textanalytics/lib/models/mappers.ts b/packages/@azure/cognitiveservices-textanalytics/lib/models/mappers.ts index 38ca1761f46a..2901131b7bf8 100644 --- a/packages/@azure/cognitiveservices-textanalytics/lib/models/mappers.ts +++ b/packages/@azure/cognitiveservices-textanalytics/lib/models/mappers.ts @@ -451,7 +451,6 @@ export const EntityRecord: msRest.CompositeMapper = { } }, matches: { - readOnly: true, serializedName: "matches", type: { name: "Sequence", @@ -487,6 +486,18 @@ export const EntityRecord: msRest.CompositeMapper = { type: { name: "String" } + }, + type: { + serializedName: "type", + type: { + name: "String" + } + }, + subType: { + serializedName: "subType", + type: { + name: "String" + } } } } diff --git a/packages/@azure/cognitiveservices-textanalytics/lib/textAnalyticsClient.ts b/packages/@azure/cognitiveservices-textanalytics/lib/textAnalyticsClient.ts index 99fea5a028e5..21b0ee254548 100644 --- a/packages/@azure/cognitiveservices-textanalytics/lib/textAnalyticsClient.ts +++ b/packages/@azure/cognitiveservices-textanalytics/lib/textAnalyticsClient.ts @@ -125,8 +125,18 @@ class TextAnalyticsClient extends TextAnalyticsClientContext { } /** - * 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 Supported + * languages in Text Analytics API 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 Supported + * Entity Types in Text Analytics API for the list of supported Entity Types. See the Supported * languages in Text Analytics API for the list of enabled languages. * @summary The API returns a list of recognized entities in a given document. diff --git a/packages/@azure/cognitiveservices-textanalytics/package.json b/packages/@azure/cognitiveservices-textanalytics/package.json index 1643dc300e28..b9d1e7ab3346 100644 --- a/packages/@azure/cognitiveservices-textanalytics/package.json +++ b/packages/@azure/cognitiveservices-textanalytics/package.json @@ -4,7 +4,7 @@ "description": "TextAnalyticsClient Library with typescript type definitions for node.js and browser.", "version": "1.0.0", "dependencies": { - "ms-rest-js": "^1.0.455", + "ms-rest-js": "^1.0.439", "tslib": "^1.9.3" }, "keywords": [