Package Exports
- @chatbotkit/sdk/bot/index.js
- @chatbotkit/sdk/bot/v1.js
- @chatbotkit/sdk/client.js
- @chatbotkit/sdk/conversation/index.js
- @chatbotkit/sdk/conversation/v1.js
- @chatbotkit/sdk/dataset/index.js
- @chatbotkit/sdk/dataset/v1.js
- @chatbotkit/sdk/fetch.js
- @chatbotkit/sdk/index.js
- @chatbotkit/sdk/skillset/index.js
- @chatbotkit/sdk/skillset/v1.js
Readme
ChatBotKit Node SDK
Welcome to the ChatBotKit SDK. This SDK is a node-based solution for building conversational AI chatbots with ease. With ChatBotKit, you can quickly develop and deploy chatbots that can interact with users in natural language.
SDK Features
- Easy setup - The ChatBotKit SDK is easy to install and set up. You can have your first chatbot up and running in minutes.
- Serverless - ChatBotKit SDK is compatible with the latest and greatest runtime environments such as Serverless and Edge with automatic support for Vercel, Netlify, Cloudflare Workerss, Deno, AWS Lambda and more.
- Modern - A modern SDK with built-in support for CommonJS, ECMAScript Modules, async/await, streams and much more.
- Customizable - You can easily customize the chatbot's behavior and responses to fit your specific use case.
ChatBotKit Features
- ๐จ Chat History: Easily review and reference previous conversations with your bots, ensuring that it has all the information it needs.
- ๐พ Custom Datasets: Manage and organize the data that your chat bots use to respond to user input with bespoke datasets.
- ๐ฌ Media File Importing: Import MP3, MP4, MPEG, WAV and many other media files directly into your your chatbot datasets
- ๐ Widget Integration: Embed ChatBotKit chatbots directly on any website using advanced customization options and theming.
- ๐ฌ Slack Bot Integration: Create and deploy wide-range of Slack bot integrations with just a few click.
- ๐ฎ Discord Bot Integration: Create and deploy wide-range of Discord chat bot with just a few click.
- ๐ฑ WhatsApp Bot Integration: Connect with your audience instantly on the worldโs most popular AI bot platform.
- ๐บ Sitemap Integration: Automatically ingest website content into a searchable knowledge base for your chatbot to reference.
- ๐ค GPT-3.5 Support: State-of-the-art language models to power your conversations.
- ๐ GPT-4 Support: The latest and best language model now can power all chatbots.
- ๐ฅ Streaming: You can turn on and off streaming capabilities for your chatbots.
- ๐จ Widget Themes: Customize the appearance of your chatbot widget with different themes to match your website branding or personal preferences.
- ๐ก ChatGPT Extended: Create your own own ChatGPT bot on variety of skills and domain-specific knowledge.
- ๐ Multiple AI Models: Leverage diverse models from various AI providers to enhance performance and accuracy.
- ๐ Data Security: Ensuring the security of user data, with robust measures in place to protect against unauthorized access.
- ๐ต Focus on Privacy: Get strong privacy controls out of the box. Privide confindence that your customers' data is being handled responsibly.
- ๐ซ Content Moderation: All messages are automatically scanned for abusive content and automatically flagged by the system.
- ๐ Semantic Search: Your chat bot can provide more relevant and accurate responses.
- โ๏ธ AI Playgrounds: Interactive environments that provide a safe and controlled space to experiment, explore, and learn.
- โ๏ธ No-Code Platform: Easily build, customize and deploy chatbots without needing to write any code.
- ๐ต Simple Pricing: Our pricing is straightforward and easy to understand, with no hidden fees or surprises.
- ๐ฑ App Platform: Our platform provides capabilities for building and deploying chatbots for a wide range of applications.
- ๐ง Extreme Customization: Customize your chatbots' responses and behavior based on variety of preferences.
- ๐ Expanding Feature Set: We are constantly adding new features to so you can always stay up-to-date with the latest AI capabilities.
Getting Started
To get started with ChatBotKit, follow these simple steps:
- Install the SDK using npm:
npm install @chatbotkit/sdk. - Use the SDK to setup or interact with your chatbot.
Here is a simple streaming example that works in Edge and Serverless environments:
import { ConversationClient } from '@chatbotkit/sdk/conversation/index.js'
for await (const { type, data } of client
.complete({ model: 'gpt-4', messages })
.stream()) {
if (type === 'token') {
process.stdout.write(data.token)
}
}Documentation
For detailed documentation on available types, please refer to the type documentation.
Checkout the ChatBotKit Documentation for more information about the platform.
Contributing
If you find a bug or would like to contribute to the ChatBotKit SDK, please open an issue or submit a pull request on the official GitHub repository.