You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A resolution is a standard format for an entity. Entities can be expressed in various forms and resolutions provide standard predictable formats for common quantifiable types. For example, "eighty" and "80" should both resolve to the integer `80`.
18
18
19
-
You can use NER resolutions to implement actions or retrieve further information. For example, your service can extract datetime entities to extract dates and times that will be provided to a meeting scheduling system.
19
+
You can use NER resolutions to implement actions or retrieve further information. For example, your service can extract datetime entities to extract dates and times that will be provided to a meeting scheduling system.
20
+
21
+
> [!IMPORTANT]
22
+
> Starting from version 2023-04-15-preview, the entity resolution feature is replaced by [entity metadata](entity-metadata.md)
20
23
21
24
> [!NOTE]
22
25
> Entity resolution responses are only supported starting from **_api-version=2022-10-01-preview_** and **_"modelVersion": "2022-10-01-preview"_**.
23
26
27
+
24
28
This article documents the resolution objects returned for each entity category or subcategory.
Copy file name to clipboardExpand all lines: articles/ai-services/language-service/named-entity-recognition/concepts/ga-preview-mapping.md
+21-12Lines changed: 21 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ms.custom: language-service-ner
14
14
15
15
# Preview API changes
16
16
17
-
Use this article to get an overview of the new API changes starting from `2023-04-15-preview` version. This API change mainly introduces two new concepts (`entity types` and `entity tags`) replacing the `category` and `subcategory` fields in the current Generally Available API.
17
+
Use this article to get an overview of the new API changes starting from `2023-04-15-preview` version. This API change mainly introduces two new concepts (`entity types` and `entity tags`) replacing the `category` and `subcategory` fields in the current Generally Available API. A detailed overview of each API parameter and the supported API versions it corresponds to can be found on the [Skill Parameters][../how-to/skill-parameters.md] page
18
18
19
19
## Entity types
20
20
Entity types represent the lowest (or finest) granularity at which the entity has been detected and can be considered to be the base class that has been detected.
@@ -23,8 +23,16 @@ Entity types represent the lowest (or finest) granularity at which the entity ha
23
23
Entity tags are used to further identify an entity where a detected entity is tagged by the entity type and additional tags to differentiate the identified entity. The entity tags list could be considered to include categories, subcategories, sub-subcategories, and so on.
24
24
25
25
## Changes from generally available API to preview API
26
-
The changes introduce better flexibility for named entity recognition, including:
27
-
* More granular entity recognition through introducing the tags list where an entity could be tagged by more than one entity tag.
26
+
The changes introduce better flexibility for the named entity recognition service, including:
27
+
28
+
Updates to the structure of input formats:
29
+
• InclusionList
30
+
• ExclusionList
31
+
• Overlap policy
32
+
33
+
Updates to the handling of output formats:
34
+
35
+
* More granular entity recognition outputs through introducing the tags list where an entity could be tagged by more than one entity tag.
28
36
* Overlapping entities where entities could be recognized as more than one entity type and if so, this entity would be returned twice. If an entity was recognized to belong to two entity tags under the same entity type, both entity tags are returned in the tags list.
29
37
* Filtering entities using entity tags, you can learn more about this by navigating to [this article](../how-to-call.md#select-which-entities-to-be-returned-preview-api-only).
30
38
* Metadata Objects which contain additional information about the entity but currently only act as a wrapper for the existing entity resolution feature. You can learn more about this new feature [here](entity-metadata.md).
@@ -54,23 +62,24 @@ You can see a comparison between the structure of the entity categories/types in
description: Learn about skill parameters for named entity recognition.
5
+
#services: cognitive-services
6
+
author: jboback
7
+
manager: nitinme
8
+
ms.service: azure-ai-language
9
+
ms.custom:
10
+
ms.topic: how-to
11
+
ms.date: 03/21/2024
12
+
ms.author: jboback
13
+
---
14
+
15
+
# Learn about named entity recognition skill parameters
16
+
17
+
Use this article to get an overview of the different API parameters used to adjust the input to a NER API call.
18
+
19
+
## InclusionList parameter
20
+
21
+
The “inclusionList” parameter allows for you to specify which of the NER entity tags, listed here [link to Preview API table], you would like included in the entity list output in your inference JSON listing out all words and categorizations recognized by the NER service. By default, all recognized entities will be listed.
22
+
23
+
## ExclusionList parameter
24
+
25
+
The “exclusionList” parameter allows for you to specify which of the NER entity tags, listed here [link to Preview API table], you would like excluded in the entity list output in your inference JSON listing out all words and categorizations recognized by the NER service. By default, all recognized entities will be listed.
26
+
27
+
## Example
28
+
29
+
To do: work with Bidisha & Mikael to update with a good example
30
+
31
+
## overlapPolicy parameter
32
+
33
+
The “overlapPolicy” parameter allows for you to specify how you like the NER service to respond to recognized words/phrases that fall into more than one category.
34
+
35
+
By default, the overlapPolicy parameter will be set to “matchLongest”. This option will categorize the extracted word/phrase under the entity category that can encompass the longest span of the extracted word/phrase (longest defined by the most number of characters included).
36
+
37
+
The alternative option for this parameter is “allowOverlap”, where all possible entity categories will be listed.
# What is Named Entity Recognition (NER) in Azure AI Language?
16
16
17
-
Named Entity Recognition (NER) is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. The NER feature can identify and categorize entities in unstructured text. For example: people, places, organizations, and quantities.
17
+
Named Entity Recognition (NER) is one of the features offered by [Azure AI Language](../overview.md), a collection of machine learning and AI algorithms in the cloud for developing intelligent applications that involve written language. The NER feature can identify and categorize entities in unstructured text. For example: people, places, organizations, and quantities. The prebuilt NER feature has a pre-set list of [recognized entities](concepts/named-entity-categories.md). The custom NER feature allows you to train the model to recognize specialized entities specific to your use case.
18
18
19
19
*[**Quickstarts**](quickstart.md) are getting-started instructions to guide you through making requests to the service.
20
20
*[**How-to guides**](how-to-call.md) contain instructions for using the service in more specific or customized ways.
21
21
* The [**conceptual articles**](concepts/named-entity-categories.md) provide in-depth explanations of the service's functionality and features.
22
22
23
-
[!INCLUDE [Typical workflow for pre-configured language features](../includes/overview-typical-workflow.md)]
23
+
> [!NOTE]
24
+
> [Entity Resolution](concepts/entity-resolutions.md) was upgraded to the [Entity Metadata](concepts/entity-metadata.md) starting in API version 2023-04-15-preview. If you are calling the preview version of the API equal or newer than 2023-04-15-preview, please check out the [Entity Metadata](concepts/entity-metadata.md) article to use the resolution feature.
24
25
26
+
[!INCLUDE [Typical workflow for pre-configured language features](../includes/overview-typical-workflow.md)]
0 commit comments