@alikjs/chatbot

@alikjs/chatbot is a powerful library designed for creating and interacting with chatbots. It offers a straightforward and flexible interface for sending messages to chatbots, managing configurations, and handling responses. The library leverages cutting-edge technologies and ensures seamless interaction across various chatbot platforms.

Key Features

1. Creating and configuring chatbots using an API key.
2. Sending messages and processing responses from the chatbot.
3. A flexible and user-friendly interface.

Installation

Install the library via npm:

npm install @alikjs/chatbot

Usage Example

Javascript:

const ChatBot = require('@alikjs/chatbot');
const { changeBotLanguage } = require('@alikjs/chatbot/dist/index');
const { getLanguage } = require('@alikjs/chatbot/src/languageHandler');

const bot = ChatBot.createChatBot({ apiKey: 'YOUR_API_KEY' });

let lang = 'en'; // По умолчанию устанавливаем английский язык

// Функция для смены языка
function changeLanguage(language) {
  changeBotLanguage(language);
  lang = language;
}

const message = {
  text: 'Hello, chatbot!',
  timestamp: Date.now(),
};

bot.sendMessage(message)
  .then(response => {
    console.log('Response from chatbot:', response);
  })
  .catch(error => {
    console.error('Error sending message:', error);
  });

// Пример использования смены языка
changeLanguage('ru');
console.log('Текущий язык:', getLanguage());

Changelog

28.12.2023 - package published... [tested]

Documentation

Welcome to the documentation for @alikjs/chatbot! This library provides functionality for interacting with chatbots using a simple and powerful API.

Methods

createChatBot(config: ChatBotConfig): ChatBotInstance Creates a new instance of the chatbot with the provided configuration.

sendMessage(message: ChatBotMessage): Promise<ChatBotResponse> Sends a message to the chatbot and returns a Promise that resolves to the response.

Configuration Options

1. apiKey: The API key required for authentication with the chatbot platform.

License

MIT License

Copyright (c) 2023 Alik

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.