11.6.1-rc.e152598 • Published 11 months ago

@koredev/kore-web-sdk v11.6.1-rc.e152598

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Kore.ai SDK

Kore.ai offers Bots SDKs as a set of platform-specific client libraries that provide a quick and convenient way to integrate Kore.ai Bots chat capability into custom applications.

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

Bot SDKs

Web Socket Endpoints and Events

SDK Security

SDK App Registration

Message Templates

API Referernce

FAQ's

💡 Getting Started

First, install kore web SDK via the npm package manager:

npm install --save kore-web-sdk

Get chatWindow and chatConfig

import { chatConfig, chatWindow } from 'kore-web-sdk';

Configure ChatConfig

let botOptions=chatConfig.botOptions;
	
 botOptions.JWTUrl = "PLEASE_ENTER_JWTURL_HERE";
 botOptions.userIdentity = 'PLEASE_ENTER_USER_EMAIL_ID';// Provide users email id here
 botOptions.botInfo = { name: "PLEASE_ENTER_BOT_NAME", "_id": "PLEASE_ENTER_BOT_ID" }; // bot name is case sensitive
 botOptions.clientId = "PLEASE_ENTER_CLIENT_ID";
 botOptions.clientSecret = "PLEASE_ENTER_CLIENT_SECRET";
 /* 
 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 chat window instance and trigger show method

var chatWindowInstance = new chatWindow(chatConfig);
chatWindowInstance.show(chatConfig);

Examples

Click here to explore different variations how SDK can be consumed

Other options

include the following script in your html file and configure bot configurations

<script  src="https://cdn.jsdelivr.net/npm/kore-web-sdk@11.6.1/dist/umd/kore-web-sdk-umd-chat.min.js"></script>
<script>
        //chat window declaration
        var chatConfig=KoreChatSDK.chatConfig;
        var chatWindow=KoreChatSDK.chatWindow;
        
        //create chat window instance
        var chatWindowInstance = new chatWindow();

        //configure bot configurations
        var botOptions=chatConfig.botOptions;
        botOptions.JWTUrl = "PLEASE_ENTER_JWTURL_HERE";
        botOptions.userIdentity = 'PLEASE_ENTER_USER_EMAIL_ID';
        botOptions.botInfo = { name: "PLEASE_ENTER_BOT_NAME", "_id": "PLEASE_ENTER_BOT_ID" }; // bot name is case sensitive
        botOptions.clientId = "PLEASE_ENTER_CLIENT_ID";
        botOptions.clientSecret = "PLEASE_ENTER_CLIENT_SECRET";
	/* 
	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/
	**/

        //show chatwindow
        chatWindowInstance.show(chatConfig);

</script>

Instructions

1.Open examples/umd/chat-with-plugins/index.html  
2.configure bot configurations   
3.Open same file in any browser 

💡 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;
      }
  } 
}

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

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

💡 Plugins

Kore's chatwindow functionlity can be extended with the help of plugins.Newly created plugins can be installed with installPlugin method

class KoreCustomPlugin{
  
}

chatWindowInstance.installPlugin(new KoreCustomPlugin());

Kore offered plugins are listed here

11.6.1-rc.5ac4dc0

11 months ago

11.6.1-rc.1c40027

11 months ago

11.6.1-rc.5d68655

11 months ago

11.6.1-rc.3153337

11 months ago

11.6.1-rc.36fe24e

11 months ago

11.6.1-rc.f64f6b4

11 months ago

11.6.1-rc.e152598

11 months ago

11.6.1-rc.74cbd55

11 months ago

11.6.1-rc.7e8aeb8

11 months ago

11.6.0-rc.8797df4

11 months ago

10.7.1-rc.f402a1f

11 months ago

10.7.0-rc.3e7b015

11 months ago

11.6.0-rc.f7643ec

11 months ago

11.6.0-rc.c4f5052

11 months ago

10.7.1-rc.2caf3ab

11 months ago

10.7.0-rc.0d4bac5

12 months ago

11.6.0-rc.2e56472

12 months ago

10.7.0-rc.36f7b81

12 months ago

11.6.0-rc.d6b8a29

12 months ago

11.6.0-rc.14091f8

12 months ago

11.6.0-rc.bc5c4e7

12 months ago

11.6.0-rc.0fe663e

12 months ago

11.6.0-rc.ec4fe81

12 months ago

11.6.0-rc.358af27

12 months ago

11.6.0-rc.ee77c09

12 months ago

11.5.1-rc.7e177eb

12 months ago

11.5.1-rc.72c7384

12 months ago

11.5.0-rc.cd82574

12 months ago

11.5.0-rc.877bafe

12 months ago

10.1.0-rc.962376

2 years ago