SearchAssist SDK

The SearchAssist web SDK is a tool for developers to add the capabilities of the SearchAssist application to their web applications. It is a client-side library that makes it easy for third-party web applications to access and use the features of SearchAssist..

With just few lines of code, you can embed our SearchAssist SDK into your applications to enable end-users to interact with your applications using Natural Language. For more information, refer to

SearchAssist SDK

💡 Getting Started

First, install searchassist SDK via the npm package manager:

npm install --save git+ssh://github.com/Koredotcom/SearchAssist-web-sdk#2.0.0

Get KRSearch and KRSearchConfig

import { KRSearch, KRSearchConfig } from 'search-assist-web-sdk';

Configure KRSearchConfig

 KRSearchConfig.botOptions.userIdentity = 'PLEASE_ENTER_USER_EMAIL_ID';// Provide users email id here
 KRSearchConfig.botOptions.botInfo = { chatBot: "PLEASE_ENTER_APP_NAME", "taskBotId": "PLEASE_ENTER_APP_ID" }; // APP name is case sensitive
 KRSearchConfig.botOptions.clientId = "PLEASE_ENTER_CLIENT_ID";
 KRSearchConfig.botOptions.clientSecret = "PLEASE_ENTER_CLIENT_SECRET";
 KRSearchConfig.botOptions.searchIndexID = "PLEASE_ENTER_SEARCHINDEX_ID";

 KRSearchConfig.botOptions.koreAPIUrl = 'PLEASE_ENTER_YOUR_API_URL'+'/searchassistapi/';
 KRSearchConfig.botOptions.baseAPIServer = 'PLEASE_ENTER_YOUR_API_URL';

 /* 
 Important Note: These keys are provided here for quick demos to generate JWT token at client side but not for Production environment.
 Refer below document for JWT token generation at server side. Client Id and Client secret should maintained at server end.
 https://developer.kore.ai/docs/bots/sdks/user-authorization-and-assertion/
 **/

Create searchassist chat window instance and trigger show method

KRSearchConfig.API_KEY_CONFIG.KEY="PLEASE_ENTER_API_KEY_HERE";
var KRSearchInstance = new KRSearch(KRSearchConfig);
KRSearchInstance.show(KRSearchConfig);

💡 Custom Templates

In addition to the kore message templates, new custom templates can be intstalled into kore chat window with installTemplate method

class customTemplateComponent{
  renderMessage(msgData){
      if(msgData?.message[0]?.component?.payload?.template_type==='custom_stock_template'){
          return '<h2>My Template HTML</h2>';      
      }else{
          return false;
      }
  } 
}

KRSearchInstance.templateManager.installTemplate(new customTemplateComponent());

Other framework UI components like angular and react can also be injected with this