SPFx Chat Bot - using SharePoint Framework Extension

 Hi Friends,


Today I have created an SPFx chatbot using the SharePoint Framework extension. This is a small simple to configure bot. It consumes the QnAMaker API to retrieve the answers for the asked questions.

SPFx Chat Bot - using SharePoint Framework Extension

The code can be found here

Features !!

  • Easy to configure with little configurations
  • Compatible with the prompts
  • Displays the formatted text as done in the knowledgebase
  • Can filter on single metadata value as well as multi values
  • Option to select the operator for the filter values
  • Its an SPFx extension, so can be deployed at a site collection level or the tenant level
 
SPFx Chat Bot - using SharePoint Framework Extension

Configuration Needed.

  • Login to the QnAMaker.ai
  • Create the knowledgebase (follow steps here )
  • Got to the settings 
  • follow the markers below to retrieve the configuration
SPFx Chat Bot - using SharePoint Framework Extension

To get the source code click here

Working Demo

SharePoint Framework chatbot using SPFx Extension


Steps for deployment

There are 2 ways how you can deploy

  • Deploying package directly
To deploy the package directly follow the below steps
  • Go to the release page on Github by clicking here
  • Download the .sppkg file from the latest release
  • Deploy the file in App Catalogue
  • When deployed successfully navigate to  Site Contents --> Tenant Wise Extensions
  • Look for the entry "ChatBot" 
  • Edit the item and fill in the Component Properties

  • Deploying via building the codebase
To deploy the package via build
  • Make a clone of the repository
  • Navigate to the folder sharepoint > assets
  • Update the properties in both ClientSiteInstance.xml & elements.xml file
  • Execute the below commands
    • npm install
    • npm bundle --ship
    • npm package-solution --ship
  • Navigate to the folder sharepoint > solution
  • you'll find the spfxqnabot.sppkg file
  • Follow the Steps mentioned in "Deploying package directly"



You can also check out my video on youtube




Happy Coding...!!
#MicrosoftSharePoint #SharePointWidgets

Comments

  1. ahSeptember 4, 2020 at 6:58 AM

    when i upload app It shows that I have a err " invaild sharepoint app package error hexadecimal value line 7 postion 68"

    ReplyDelete
    Replies
    1. Sumit KanchanSeptember 4, 2020 at 1:34 PM

      Hi, can you please send me the screenshot of the error on sumit.kanchan04@gmail.com

      Delete
    2. Sumit KanchanSeptember 5, 2020 at 1:14 AM

      Hi, issue has been fixed, please take the latest code/sppkg file from GitHub.

      Thanks,
      Sumit Kanchan

      Delete
  2. ahSeptember 4, 2020 at 6:58 AM

    This comment has been removed by a blog administrator.

    ReplyDelete
  3. ahSeptember 4, 2020 at 6:58 AM

    Could you explain step by step because I have a problem with uploading the application pls

    ReplyDelete
  4. Tarun VatsSeptember 6, 2020 at 9:06 AM

    Superb 🙂

    ReplyDelete
  5. UnknownDecember 18, 2020 at 7:42 PM

    Hey, thank you for the project it's really cool. I have a question please how to connect this with a directline secret whitout passing with Q&A Maker. thank you

    ReplyDelete
    Replies
    1. Sumit KanchanDecember 22, 2020 at 3:38 PM

      Good to know that you find the project interesting :). As for the question is to bypass the QnA Maker, we cannot as the KB and service is provided by the QnA Maker. Not sure if I have answered your query. Please let me know if I have misunderstood your query.

      Delete
    2. UnknownDecember 24, 2020 at 6:42 AM

      Actually I want to connect the bot with a directline service without using th e Q&A maker !

      Delete
  6. AnonymousMay 5, 2021 at 11:49 PM

    I have a QnA Maker multi-turn knowledge base set up, where I provide the user with clickable options versus just typing random text in the box. I have found several of these types of projects on Github but none of them seem to work with the conversational multi-turn QnA Maker template. Thoughts?

    ReplyDelete
    Replies
    1. Sumit KanchanMay 10, 2021 at 8:58 PM

      What error are you getting, Can you look into the browser logs and network logs if you are getting anything there. I have checked the application with multi-turn KB and it works just fine.

      Delete

Post a Comment

Popular posts from this blog

SharePoint Framework (SPFx) Tab Control (react)

Image
Hi Friends, This time I have worked upon a tab control which is still missing from Microsoft sample collection. I personally felt this tab control webpart can be of use in many scenarios. I have used the Rich Text editor for the implementation, where whenever a new tab is added , the text editor automatically gets associated with the tab. Since it is the rich text editor so you can do almost everything you want to display with all the custom formatting options available. Source Code on GitHub Features ! No configuration for the webpart to use Safe and fast as there is no external saving of data Rich Text editor increases lot of possibilities how you use it Light weight control Installation $ npm install $ gulp clean $ gulp bundle --ship $ gulp package-solution --ship Below are some of the images that demonstrates the webpart. View Mode Edit Mode Please provide your comments , if you need any more feature or how you like the control. Hap
Read more

Sorting in Typescript (Simple Arrays & Array of Objects)

Image
Hi Friends, This post is not regarding the SharePoint but it is a very common functionality that we need in day to day coding. So I thought to write down here. This functionality is of sorting in Typescript. Sorting simple Arrays Sorting is the very basic functionality that is required and when it comes to typescript  we do get OOB method, but that is for the simple array.    let  fruits : string []  =  [ ' Banana ' ,  ' Orange ' ,  ' Apple ' ,  ' Pineapple ' ] ;    console . log (fruits. sort ()); Output : Apple, Banana, Orange, Pineapple Sorting an Array of Objects When it comes to sorting the array of objects, we do not have any OOB method which can serve our purpose. for this, we have to write our small custom logic within the sort method let  fruits :   any []  =  [{ Name :   ' Banana '  }, { Name :   ' Orange '  },  { Name :   ' Apple '  }, { Name :   ' Pineapple '  }];    console . log (frui
Read more

SharePoint Image Gallery

Image
 Hi Friends, SharePoint Framework Image Gallery webpart will allow you to create a image gallery with lot of options. These are beautiful galleries options with responsiveness and configurations. In this webpart, there are 3 types of gallery views, which will help you in desiging your SharePoint page more attractive and more meaningful Check the code here Gallery Views Lightbox Layout Carousel layout List Layout Features..!! Add Captions to the images Create redirect links with any view Add description to the List layout for more information Choose source from the current site or any other site Option to choose from multiple document libraries Option to choose from the number of images Option to choose from the auto-rotation and the duration in the carousel layout Option to choose from number of images in a row, set as per your area Lightbox Layout Screen This layout is a flexible layout where multiple images can be displayed in a small area. You have the option to choose the number of
Read more