Entity types and their purposes in LUIS

Entities extract data from the utterance. Entity types give you predictable extraction of data. There are two types of entities: machine-learned and non-machine-learned. It is important to know which type of entity you are working with in utterances.

Entity compared to intent

The entity represents a word or phrase inside the utterance that you want extracted. An utterance can include many entities or none at all. A client application may need the entity to perform its task or use it as a guide of several choices to present to the user.

An entity:

  • Represents a class including a collection of similar objects (places, things, people, events or concepts).
  • Describes information relevant to the intent

For example, a News Search app may include entities such as “topic”, “source”, “keyword” and “publishing date”, which are key data to search for news. In a travel booking app, the “location”, “date”, "airline", "travel class" and "tickets" are key information for flight booking (relevant to the "Book flight" intent).

By comparison, the intent represents the prediction of the entire utterance.

Entities help with data extraction only

You label or mark entities for the purpose of entity extraction only, it does not help with intent prediction.

Entities represent data

Entities are data you want to pull from the utterance. This can be a name, date, product name, or any group of words.

Utterance Entity Data
Buy 3 tickets to New York Prebuilt number
Location.Destination
3
New York
Buy a ticket from New York to London on March 5 Location.Origin
Location.Destination
Prebuilt datetimeV2
New York
London
March 5, 2018

While intents are required, entities are optional. You do not need to create entities for every concept in your app, but only for those required for the client application to take action.

If your utterances do not have details your bot needs to continue, you do not need to add them. As your app matures, you can add them later.

If you're not sure how you would use the information, add a few common prebuilt entities such as datetimeV2, ordinal, email, and phone number.

Label for word meaning

If the word choice or word arrangement is the same, but doesn't mean the same thing, do not label it with the entity.

The following utterances, the word fair is a homograph. It is spelled the same but has a different meaning:

Utterance
What kind of county fairs are happening in the Seattle area this summer?
Is the current rating for the Seattle review fair?

If you wanted an event entity to find all event data, label the word fair in the first utterance, but not in the second.

Entities are shared across intents

Entities are shared among intents. They don't belong to any single intent. Intents and entities can be semantically associated but it isn't an exclusive relationship.

In the utterance "Book me a ticket to Paris", "Paris" is an entity referring to location. By recognizing the entities that are mentioned in the user’s utterance, LUIS helps your client application choose the specific actions to take to fulfill the user's request.

Mark entities in None intent

All intents, including the None intent, should have marked entities, when possible. This helps LUIS learn more about where the entities are in the utterances and what words are around the entities.

Entity status for predictions

The LUIS portal tells you when the entity in an example utterance is either different from the marked entity or is too close to another entity and therefore unclear. This is indicated by a red underline in the example utterance.

For more information, see Entity Status predictions.

Types of entities

LUIS offers many types of entities. Choose the entity based on how the data should be extracted and how it should be represented after it is extracted.

Entities can be extracted with machine-learning, which allows LUIS to continue learning about how the entity appears in the utterance. Entities can be extracted without machine-learning, matching either exact text or a regular expression. Entities in patterns can be extracted with a mixed implementation.

Once the entity is extracted, the entity data can be represented as a single unit of information or combined with other entities to form a unit of information the client-application can use.

Machine-learned Can Mark Tutorial Example
Response
Entity type Purpose
Composite Grouping of entities, regardless of entity type.
List List of items and their synonyms extracted with exact text match.
Mixed Pattern.any Entity where end of entity is difficult to determine.
Prebuilt Already trained to extract various kinds of data.
Regular Expression Uses regular expression to match text.
Simple Contains a single concept in word or phrase.

Only Machine-learned entities need to be marked in the example utterances. Machine-learned entities work best when tested via endpoint queries and reviewing endpoint utterances.

Pattern.any entities need to be marked in the Pattern template examples, not the intent user examples.

Mixed entities use a combination of entity detection methods.

Composite entity

A composite entity is made up of other entities, such as prebuilt entities, simple, regular expression, and list entities. The separate entities form a whole entity.

This entity is a good fit when the data:

  • Are related to each other.
  • Are related to each other in the context of the utterance.
  • Use a variety of entity types.
  • Need to be grouped and processed by the client application as a unit of information.
  • Have a variety of user utterances that require machine-learning.

composite entity

Tutorial
Example JSON response for entity

List entity

List entities represent a fixed, closed set of related words along with their synonyms. LUIS does not discover additional values for list entities. Use the Recommend feature to see suggestions for new words based on the current list. If there is more than one list entity with the same value, each entity is returned in the endpoint query.

The entity is a good fit when the text data:

  • Are a known set.
  • The set doesn't exceed the maximum LUIS boundaries for this entity type.
  • The text in the utterance is an exact match with a synonym or the canonical name. LUIS doesn't use the list beyond exact text matches. Stemming, plurals, and other variations are not resolved with a list entity. To manage variations, consider using a pattern with the optional text syntax.

list entity

Tutorial
Example JSON response for entity

Pattern.any entity

Pattern.any is a variable-length placeholder used only in a pattern's template utterance to mark where the entity begins and ends.

The entity is a good fit when:

Example
Given a client application that searches for books based on title, the pattern.any extracts the complete title. A template utterance using pattern.any for this book search is Was {BookTitle} written by an American this year[?].

In the following table, each row has two versions of the utterance. The top utterance is how LUIS will initially see the utterance, where it is unclear with the book title begins and ends. The bottom utterance is how LUIS will know the book title when a pattern is in place for extraction.

|Utterance| |--| |Was The Man Who Mistook His Wife for a Hat and Other Clinical Tales written by an American this year?<br>Was **The Man Who Mistook His Wife for a Hat and Other Clinical Tales** written by an American this year?| |Was Half Asleep in Frog Pajamas written by an American this year?<br>Was Half Asleep in Frog Pajamas written by an American this year?| |Was The Particular Sadness of Lemon Cake: A Novel written by an American this year?<br>Was The Particular Sadness of Lemon Cake: A Novel written by an American this year?| |Was There's A Wocket In My Pocket! written by an American this year?<br>Was There's A Wocket In My Pocket! written by an American this year?`|

Prebuilt entity

Prebuilt entities are built-in types that represent common concepts such as email, URL, and phone number. Prebuilt entity names are reserved. All prebuilt entities that are added to the application are returned in the endpoint prediction query if they are found in the utterance.

The entity is a good fit when:

  • The data matches a common use case supported by prebuilt entities for your language culture.

Prebuilt entities can be added and removed at any time.

Number prebuilt entity

Tutorial
Example JSON response for entity

Some of these prebuilt entities are defined in the open-source Recognizers-Text project. If your specific culture or entity isn't currently supported, contribute to the project.

Troubleshooting prebuilt entities

In the LUIS portal, if a prebuilt entity is tagged instead of your custom entity, you have a few choices of how to fix this.

The prebuilt entities added to the app will always be returned, even if the utterance should extract custom entities for the same text.

Change tagged entity in example utterance

If the prebuilt entity is the same text or tokens as the custom entity, select the text in the example utterance and change the tagged utterance.

If the prebuilt entity is tagged with more text or tokens than your custom entity, you have a couple of choices of how to fix this:

Remove example utterance to fix tagging

Your first choice is to remove the example utterance.

  1. Delete the example utterance.
  2. Retrain the app.
  3. Add back just the word or phrase that is the entity, which is marked as a prebuilt entity, as a complete example utterance. The word or phrase will still have the prebuilt entity marked.
  4. Select the entity in the example utterance on the Intent page, and change to your custom entity and train again. This should prevent LUIS from marking this exact text as the prebuilt entity in any example utterances that use that text.
  5. Add the entire original example utterance back to the Intent. The custom entity should continue to be marked instead of the prebuilt entity. If the custom entity is not marked, you need to add more examples of that text in utterances.

Remove prebuilt entity to fix tagging

  1. Remove the prebuilt entity from the app.
  2. On the Intent page, mark the custom entity in the example utterance.
  3. Train the app.
  4. Add the prebuilt entity back to the app and train the app. This fix assumes the prebuilt entity isn't part of a composite entity.

Regular expression entity

A regular expression is best for raw utterance text. It ignores case and ignores cultural variant. Regular expression matching is applied after spell-check alterations at the character level, not the token level. If the regular expression is too complex, such as using many brackets, you're not able to add the expression to the model. Uses part but not all of the .NET Regex library.

The entity is a good fit when:

  • The data are consistently formatted with any variation that is also consistent.
  • The regular expression does not need more than 2 levels of nesting.

Regular expression entity

Tutorial
Example JSON response for entity

Simple entity

A simple entity is a generic entity that describes a single concept and is learned from the machine-learned context. Because simple entities are generally names such as company names, product names, or other categories of names, add a phrase list when using a simple entity to boost the signal of the names used.

The entity is a good fit when:

  • The data aren't consistently formatted but indicate the same thing.

simple entity

Tutorial
Example response for entity

Entity limits

Review limits to understand how many of each type of entity you can add to a model.

If you need more than the maximum number of entities

You might need to use composite entities in combination with entity roles.

Composite entities represent parts of a whole. For example, a composite entity named PlaneTicketOrder might have child entities Airline, Destination, DepartureCity, DepartureDate, and PlaneTicketClass.

LUIS also provides the list entity type that isn't machine-learned but allows your LUIS app to specify a fixed list of values. See LUIS Boundaries reference to review limits of the List entity type.

If you've considered these entities and still need more than the limit, contact support. To do so, gather detailed information about your system, go to the LUIS website, and then select Support. If your Azure subscription includes support services, contact Azure technical support.

Next steps

Learn concepts about good utterances.

See Add entities to learn more about how to add entities to your LUIS app.