@leezyai/chat v0.2.3

leezyAI Chatbot

This is a JavaScript chatbot plugin with heavy TypeScript support that can be easily embedded into any website. The plugin is packaged as an npm module, making it simple to install and use with frameworks like Nuxt.js or plain JavaScript.

Features

• AI-Powered Chatbot: Provides interactive chat support using AI technology.
• Customizable Interface: You can easily style and adjust the chatbot appearance.
• Multi-language Support: Ready for multilingual customer interaction.
• Embeddable Widget: Quickly add the chatbot to your website with a script or HTML tag.

Installation

To install the plugin, use npm or yarn:

Using npm

npm i @leezyai/chat

Using yarn

yarn add @leezyai/chat

Usage

Import and Initialize the Chatbot

After installation, import the module and initialize it in your project:

import { AIChatbot } from '@leezyai/chat'

await AIChatbot.resetInstance({
  accessKey: 'YOUR_API_KEY'
})

Adding the Chatbot Widget to Your Website

If you want to embed the chatbot directly into your HTML, add the following snippet:

<ai-chatbot leezy-id="your-api-key"></ai-chatbot>

Make sure to replace 'your-api-key' with your actual API key. Which you can obtain here.

Configuration Options

• apiKey: Your unique API key to authenticate the chatbot.
• embedded: Decide if the chatbot is bound to an iframe (fixed to bottom right), or embed it anywhere on your website.

TypeScript Support

The package includes TypeScript type definitions, which means you'll get autocomplete and type-checking features while coding:

Issues & Troubleshooting

If you experience any issues, make sure to:

• Check API Key: Ensure your API key is correct and active.
• Browser Console: Look for any console errors for more detailed information.

Feel free to open an issue on GitHub if you need further assistance.

Contributing

For now contribution is not possible as of closed source. This may change in the future.

License

This project is licensed under the ISC License.