❤
npm
Sign UpSign In

widget-ccat-v2

1.0.1 • Public • Published

Cheshire Cat React Widget v2 NPM PACKAGE

What is the Cheshire Cat Widget:

This is a fork of the official react widget created by Andrea Pesce on https://github.com/AndreaPesce2002/widget-CCAT-react

The Cheshire Cat React widget is a widget built on the React Framework and is designed to be used along with the Cheshire Cat AI framework with the purpose to act as an LLM powered assistant that can be easily installed on any website.

By utilizing the Cheshire Cat AI's plugin customization capabilities you can adjust the behavior of the assistant to suit the needs of your orginazation/application.

This widget's Communication is based on the Cheshire Cat API available through npm ( see https://github.com/cheshire-cat-ai/api-client-ts ).

This new version of the Widget is operating on the same design as the widget made by Andrea Pesce with some additional functions and improvements on the way the token streaming is being handled, how the widget is being displayed and many more .

The widget consists of the functions bellow:

  • RestCat along with a useEffect hook : a function that initializes a new Cat Connection and websocket stabilization.
  • sendMessage along with a useEffect hook : a function that manages the exchange of messages between the user and the Cat.
  • Spinner : a small spinner animation that is being displayed on widget start until the websockets get stabilized.
  • msgTokenAdd : a function that handles the token streaming.
  • scrollToBottom : A function that keeps the screen view of the widget on the last message exchanged.
  • translator : a function that handles the language that the widget's messages are being displayed in , depending on the user's browser preferred language.

What was updated/Upgraded :

  • The RestCat function now waits till the websockets have stabilized
  • The SendMessage Function can now handle streaming messages
  • Added a functionality where the chat is not ready mode while the first sockets stabilize ( not well implemented )
  • Chat Screen Shows the bottom/newest text while sending/receiving
  • Handling multiple Languages dynamically
  • Added the possibility to have open-chat-img and close-chat-img

More information on the updated and improved capabilities of the widget follow bellow.

NPM Package Information:

The npm package is made using Webpack and Babel. The exact configurations can be found in the webpack.config.js, .babelrc, and package.json.

In order to update/upgrade the npm package you should:

  • Implement the changes on the src/index.js
  • Commit any changes
  • Adjust the version of the package on the package.json either manually or by executing : npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git] ( for more information regarding the versioning you can visit: https://docs.npmjs.com/cli/v7/commands/npm-version )
  • Execute npm run build on the CLI, or just bash npm publish which will build the package and then publish it to the npm registry

This way you have successfully updated/upgraded the widget-ccat-v2 npm package! Note: If you are interested in making any changes on the way the widget is operating, it could be easier to :

And after you have made sure that the changes you have implemented are working, you can proceed to implement the changes to the npm package.

How to Integrate the widget in your App :

You can use this widget:

  • Clone the wigdet in the src/ directory of your project Or
  • Install the npm package of this widget by executing bash npm i widget-ccat-v2 ,

And import it on your App.js

import WidgetCCAT from 'widget-ccat';

function App() {
  return (
    <div>
      <WidgetCCAT 
        baseUrl="http://localhost" 
        port="1865"
        userID = "user",
        closed_icon= "https://cheshire-cat-ai.github.io/docs/assets/img/cheshire-cat-logo.svg",
        open_icon = "https://cheshire-cat-ai.github.io/docs/assets/img/cheshire-cat-logo.svg",
        sockets_await = 5,
        widget_width = 330,
        widget_height = 600,

        translatedText = {
          en: {  
            initialPhrase: "Welcome, how may I assist you today?",
            sorryPhrase: "Sorry , something went wrong ...",
            chatUnderneathMessage: "The assistant sometimes can 'lie', please take care.",
            widget_loading_message : "Loading, please wait...",
            process_wait_text : "Please wait till the process has finished."
            
          }
        } 
      />
    </div>
  );
}

Components and Functionalities

Where the arguments passed above are :

Arguments Type Description Default Value
baseUrl string The url to your Cat server localhost
port string The port to your server 1865
userID string The userID of the widget-client user
closed_icon string The url to the icon that will show when the widget is closed https://cheshire-cat-ai.github.io/docs/assets/img/cheshire-cat-logo.svg
open_icon string The url to the icon that will show when the widget is closed https://cheshire-cat-ai.github.io/docs/assets/img/cheshire-cat-logo.svg
sockets_await int The number of socket connections in order to let the cat stabilize 5
widget_width int The desired width of the widget 330
widget_height int The desired width of the widget 600
translatedText Object An object that contains the widget's message texts See bellow

Where the translatedText contents are :

Object Name Type Description Default
LanguageCode string the 2 character-long of the desired language ( has to be the same with the browser) 'en'

And the above Objects' contents:

Arguments Type Description Default
initialPhrase string The first message displayed when the widget is initialized "Welcome, how may I assist you today?
sorryPhrase string The message shown by the widget if something goes wrong "Sorry , something went wrong ..."
chatUnderneathMessage string A small message shown under the user input box "The assistant sometimes can 'lie', please take care."
widget_loading_message string A message shown by the widget while waiting for the sockets to stabilize "Loading, please wait..."
process_wait_text string A message also shown when the widget is waiting for socket stabilization "Please wait till the process has finished."

Upgraded Functionalities:

RestCat Websocket Stabilization :

We have noticed that the CCatAPI takes some websocket connection in order to stabilize and be available for use ( in our case it is 5). So bearing that in mind we have an argument on the widget initialization where you can set these cycles manually ( needs a better implementation )

Send Message function :

The Send message function has been improved on the part of token handling ( if the LLM that is being used by the Cheshire Cat is streaming ), where the new tokens are being concatenated on the response-message. The streaming responses of the CCatAPI send each token in a json object format and are tagged with the element "type" which is either :

  • type : chat , the complete response , sent in the end of the response generation
  • type : chat-type , NOT SURE IF IS THE CORRECT NAME, token generated to form a complete response

The way the sendMessage is being implemented in this version of the widget is that we add every token to an response message every time a token is sent, and when the complete response is being sent in the end , we ignore it and set the widget's isProcessing to False.

In order to make the above functionality working we implemented a function msgTokenAdd(msg), where msg is a token.

Chat Screen Shows the bottom/newest text while sending/receiving

This is functionality is being deployed by the use of scrollToBottom() function that operates in a useEffect every time there is a change on the messages Hook.

Handling multiple Languages dynamically

This functionality works on along with an object argument passed on the widget initialization of type :

translatedtext = {
  en:{},
  de:{},
  it:{},
  .
  .
  .
}

Where there each language must contain the elements bellow:

  • initialPhrase
  • sorryPhrase
  • chatUnderneathMessage
  • widget_loading_message
  • process_wait_text

There is a default Value of translatedText :

translatedText = {
  en: {  
      initialPhrase: "Welcome, how may I assist you today?",
      sorryPhrase: "Sorry , something went wrong ...",
      chatUnderneathMessage: "The assistant sometimes can 'lie', please take care.",
      widget_loading_message : "Loading, please wait...",
      process_wait_text : "Please wait till the process has finished."
      
    }
}

The functionality above is being handled by the function translator(), where the default preferred language of the browser is being used to determine the display language of the messages show by the bot.

Additional Capabilities

  • You can also add different images for when the chat is closed and when it is open, just change the parameters of open_icon and close-icon when initializing the widget

Useful links

Readme

Keywords

Package Sidebar

Install

npm i widget-ccat-v2

Repository

github.com/conveos/widget-CCAT-react/tree/feature

Homepage

github.com/conveos/widget-CCAT-react/tree/feature#readme

Weekly Downloads

62

Version

1.0.1

License

ISC

Unpacked Size

72 kB

Total Files

5

Last publish

Collaborators

  • manousakos
Try on RunKit
Report malware