Amity Solutions
  • Announcements
  • Amity Bots Platform
    • Dashboard
      • User Journey
    • Users
      • Setup Microsoft Entra ID Integration
      • Password Policy
      • Typing animation
    • Channels
      • Connect to Facebook Page
      • Connect to LINE Official Account
      • Using Webchat SDK
      • Connet to Custom Channel
    • Audience
    • Chatbot
      • Intent
      • Entity
      • Mapper
      • Chatlogic
    • Message Template
      • Creating Message Template
      • Message Types Examples
    • Rich Menu
      • Linking Rich Menu to Channel
    • Campaign
      • Broadcast
      • ChatAds
  • Amity Bots Live Chat
    • Channels
    • Ticket
      • Ticket Management
      • Ticket Detail
      • Ticket Wrap up
      • Auto assign
    • Team Management
    • Livechat
    • Message Type
    • Livechat Dashboard
    • Audience's Profile
    • Customer Satisfaction Survey
      • Customer Satisfaction Score
    • Agent Copilot✨
  • Amity Bots Gen AI Platform
    • Dashboard
    • Assistants
      • Chat Sandbox
      • Assistant API Integration
      • Message Report
    • Fulfillments
    • Knowledge Base
      • Documents and Files (Legacy)
      • CSV File
      • Documents and Files
      • External Knowledge Base
    • AI Lab
    • Memorized Response
  • Insight
    • Journey Insight
  • Guides
    • Creating a simple chatbot
    • Setting up a LINE Rich Menu
    • How to use ChatAds
  • API Reference
  • Versioning & Upgrade Policy
Powered by GitBook
On this page
  • Creating Entities
  • Edit Entity
  • Delete Entity
  • Search Entity
  • Supported Entities Format

Was this helpful?

  1. Amity Bots Platform
  2. Chatbot

Entity

PreviousIntentNextMapper

Last updated 1 year ago

Was this helpful?

Here, you'll be diving into the specific details and nuances that make user messages unique. While intents capture the broader goals of user interactions, entities focus on the specific pieces of information users provide. Whether it's a location, a date, a product name, or any other specific detail, entities help your chatbot grasp and utilize these finer points to generate more precise and contextual responses. By defining and managing entities in this section, you equip your chatbot with the tools to engage in richer, more informed conversations.

Creating Entities

To create a new entity:

  1. Go to Chatbot > Entity

  2. Click Create Entity

  3. Enter Entity Name

  4. Select Attribute:

    • Auto Detect - When disabled the entity will only be analyzed when the bot is asking for the entity. When enabled the entity will be automatically for all incoming messages.

  5. Click Create

Edit Entity

  1. Locate the entity you wish to edit from the list on the left side.

  2. Update the necessary fields. Ensure that all product specifications adhere to the guidelines provided in the table above.

  3. Once you've made the necessary changes, click the Update button.

  4. Note: The format of the entity cannot be altered.

Delete Entity

  1. Choose the entity you intend to delete from the list on the left side.

  2. Click on the trash bin icon to initiate the deletion process.

  3. Confirm your intention by selecting Delete.

Search Entity

  1. To search for an entity, begin by typing its name.

  2. Input the desired name and either press Enter or click the Search button.

  3. To return to the main entity page, clear the search input and either press Enter or click the Search button again.

Supported Entities Format

Format

Details

Options

  • Detect list of pre-defined options

  • Configuration:

    • Options: Option entry, which can contain up to 20 synonyms (keywords) to search for.

  • Examples: Color, Brands

Number

  • Detect number

  • Configuration:

    • Min and Max: Minimum and Maximum value to be detected as the entity.

  • Examples: Age, Price

Date

  • Detect date

  • Examples: Birthday, Expiry date

Location

  • Detect location

  • Configuration:

    • Custom Locations:

      • Name: Name of the custom location

      • Latitude, Longitude: Location of the custom location

      • Synonyms: Keyword that represents the custom location

  • Examples: User Location, Home Address

Country

  • Detect Country

  • Examples: Home Country, Destination Country

Phone

  • Detect Phone Number

  • Examples: User Phone Number

Email

  • Detect email

  • Configuration:

    • Domain: Comma-separated domain name of the email to limit the detection to. Leave this blank to detects email from any domain name.

  • Examples: User Email Address

Text

  • Capture incoming text

  • Examples: Asking for user feedback

  • Since the entity detects the whole incoming text, auto-detect cannot be turned on

Custom

  • Detect string with custom pattern

  • Configuration:

    • Pattern: Regular Expression that starts and ends with /

  • Example: Serial Number, User ID

Choose Format Type ()

to learn more about Regular Expression syntax.

see table below
Click here