Guide FloatChat

Floatchat- User Guid

Entities

1. Introduction #

Entities are data points or values that can be extracted from user queries in a conversation. They allow for customization of the collected information, association, and the ability to add custom values. Instead of creating separate FAQs for different variables, entities can be used when multiple values lead to the same answer.

1.1 Availability #

This functionality is available to all our customers. You can access it by clicking on the Train tab in the left panel and selecting Entities.

Entities

1.2 Terms and Definitions #

Terms 

Definitions 

Entity

It is a data point or value that can be extracted from a conversation/user query. It helps in customizing the collected information or adding custom values.

FAQ

Frequently Asked Questions (FAQs) are standard queries relevant to a product or service.

Intent 

It refers to the intention or purpose of the user in the conversational flow.

Context 

It maintains the relevance of communication based on the user’s previous conversation with the bot.

System Defined Entities 

These are commonly used entities that are pre-defined in the system.

Custom Entities 

These are entities defined by the user based on their specific use case.

2. Entity Management #

2.1 Creating an entity #

Click on the Train tab and select the Entity section to manage entities. Click on the “Add Entity” button to create a new entity type.

Entities

2.2 Naming your Entities #

You can give any name to your entity related to the information you are collecting, such as booking_date, courses, products, etc. The name cannot contain spaces or slash characters, and it cannot be the same as a built-in entity type like number, date, time, etc. The name is important as it will be used extensively to refer to the extracted values in the conversation. You can define multiple entities of the same type if needed.

3. Types of Entities #

Entities can be built-in or system-defined, and custom-defined. 

3.1 Built-in or System entities #

Built-in or system entities are pre-defined types that cover common use cases.

Entities

3.2 Custom entities #

Custom entities allow you to define your own types and values specific to your bot, organization, or domain.

Entities

4. Entities usage #

Entities can be associated with FAQs to extract specific pieces of data/information from user intents. You can define which entities to look for in a particular intent and specify if they are mandatory. Entities can also be used to extract information in the Request User Data section. Multiple entities can be requested in a single query, and the bot will intelligently associate the values appropriately. Extracted values can be referred to using double braces notation, for example, {{context.booking_date}}. Complex entities may have parts to their values, which can be referred to by qualifying the entity name, such as {{context.booking_date.month}}.

Entities

4.1 Scenario #

For example, if there is a common procedure for enrolling in multiple subjects, instead of creating separate FAQs for each subject, you can create an entity of type Course and tag that entity in one FAQ.

Entities

4.2 Deletion of entities #

When deleting entities, caution should be exercised to ensure they are not being used in intents or paths. Deleting entities used in flows or intents can lead to unstable behavior or inconsistent values.

4.3 Renaming of entities #

Entities can be renamed, but care should be taken to ensure they are not in use in intents or flows. Renaming entities in use can lead to inconsistent behavior.

What are your feelings
Scroll to Top