User Guide

User Guide

  • Conversation
  • Vision
  • Speech
  • Languages iconEnglish
    • Tiếng Việt

›Add-ons

Documentation

  • Introduction
  • Bot Creator

    • Introduction
    • General
    • Bot
    • Scenario
    • NLP
    • QnA
    • History
    • Dashboard
    • Broadcast
    • Message
    • Persistent Menu (Facebook + Livechat only)
    • Auto Comment (Facebook Only)
    • Settings

    Add-ons

    • Rating Add-on
    • Survey Add-on
  • Chat Bot SDK
  • Appendices

Tutorials (Videos)

  • 1. Brief overview of FPT.AI
  • 2. Using QnA feature to create a Chatbot
  • 3. Creating Chatbot with complicated scenarios
  • 4. Precondition fucntion in Scenarios
  • 5. Random answer function in Scenarios
  • 6. NLP feature
  • 7. Exact match and Predictive Match in NLP
  • 8. History of Recognition
  • 9. Broadcast feature
  • 10. Live Support feature
  • 11. Persistent Menu
  • 12. Auto-comment feature on Facebook
  • 13. Bot roles
  • 14. Bot configuration in Settings section
  • 15. Integration Chatbot with Facebook
  • 16. Integration Chatbot with Facebook at Work

API Reference

  • Introduction
  • General
  • Natural Language Processing

    • Intent
    • Entity
    • Sample
    • Train
    • Predict
    • Keyword
    • Dictionary

    Dialogue Management

    • Get Answer
    • Broadcast
    • JSON Card
    • Types of the message

Add-ons

Rating Guide Line

Rating Add-ons allows bot to collect and manage ratings from users.

Manage Add-on

Access: https://rating.fpt.ai. Login with FPT ID account.

Add a new Rating Item

  • Create a new Rating Item: Addon-Step-1
  • Copy token:
    Token is used for bot to call add-on
    Addon-Step-2

Get detail report for a Rating Item

  • Users statistics
    Addon-Step-3
  • The statistics includes:
    • Rating Item name
    • Total rates
    • Average Stars (value)
    • List of users' ratings

Addon-Step-4

Manage Bot

Bot is created to use rating add-on

Access: http://bot.fpt.ai. Login with FPT ID account

Create new bot

Setup variables

IDVariable nameEntity TypeValidationDescription
4rate_successNonetextRating status ("1": success, "0": fail)
5rate_levelNonetextA value from "1" to "5" represents the number of stars rated by user
6one_starsNonetextNumber of users rated 1 star
7two_starsNonetextNumber of users rated 2 stars
8three_starsNonetextNumber of users rated 3 stars
9four_starsNonetextNumber of users rated 4 stars
10five_starsNonetextNumber of users rated 5 stars
11one_stars_percentageNonetextPercentage of users rated 1 star over all users
12two_stars_percentageNonetextPercentage of users rated 2 stars over all users
13three_stars_percentageNonetextPercentage of users rated 3 stars over all users
14four_stars_percentageNonetextPercentage of users rated 4 stars over all users
15five_stars_percentageNonetextPercentage of users rated 5 stars over all users
16total_ratesNonetextTotal ratings
17mean_of_starsNonetextMean of rating stars
18commentNonetextUser's comment belong to the rate

Setup constant

IDConstant nameValueDescription
1tokentextAuthorized key to call rating add-on (Key can be copied as described above)

Setup scenario

  • Add step Rate
    • Add Quick Reply card:
      Message: Welcome to rating add-on
      Add Button: Five button for five rate level
      • Button Setting:
        Type: To Step
        Name: 1 star
        Action: RateProcess
        Data Payload: {"set_attributes": {"rate_level": "1"}}
        Bot-Quick-Rep

Bot-Quick-Rep

Add step RateProcess

  • Add JSON card:
    Method: POST
    URL: https://rating.fpt.ai/api/rates/
    Authorization: Bearer {{token}}
    Variable: sender_id, session_id, app_code, rate_level, comment

    Bot-Rate

Add step RateResult

  • Add JSON card:
    Method: GET
    URL: https://rating.fpt.ai/rate-result/
    Authorization: Bearer {{token}}
    Variable: app_code

    Bot-Rate-Result
← SettingsSurvey Add-on →
  • Manage Add-on
    • Add a new Rating Item
    • Get detail report for a Rating Item
  • Manage Bot
    • Create new bot
    • Setup variables
    • Setup constant
    • Setup scenario
    • Add step RateProcess
    • Add step RateResult
Conversation
DocumentationTutorials (Video)API Reference
Vision
DocumentationAPI Reference
Speech
DocumentationAPI Reference
Copyright © 2019 FPT Corporation