-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9bae162
commit 45b4d83
Showing
1 changed file
with
23 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,51 @@ | ||
| [](https://twitter.com/chatbotkit) | ||
| [](https://chatbotkit.com) | ||
| [](https://www.npmjs.com/package/@chatbotkit/sdk) | ||
|
|
||
| # ChatBotKit Node SDK | ||
|
|
||
| Welcome to the ChatBotKit SDK. This SDK is a node-based solution for building conversational AI chatbots with ease. With [ChatBotKit](https://chatbotkit.com), you can quickly develop and deploy AI bots 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. | ||
| - 💾 **Custom Skillset**: Create special skills for your chatbot, such as the ability to generate images or fetch web pages. | ||
| - 🎬 **Document File Importing**: Import PDF, CSV, JSON, MD and many other document files directly into your your chatbot 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. | ||
| - 🗺 **Suppoert Integration**: Automatically send conversation summaries to your prefered support system and follow up with users off-session. | ||
| - 🤖 **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. | ||
| - 🔒 **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. | ||
| - 💵 **Simple Pricing**: Our pricing is straightforward and easy to understand, with no hidden fees or surprises. | ||
| Welcome to the ChatBotKit Node SDK. This is a Node.js-based solution designed to simplify the process of building conversational AI chatbots. Utilize [ChatBotKit](https://chatbotkit.com) to rapidly develop and deploy AI bots capable of natural language interactions. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get started with ChatBotKit, follow these simple steps: | ||
| Embark on creating your chatbot with ChatBotKit in a few easy steps: | ||
|
|
||
| 1. Install the SDK using npm: `npm install @chatbotkit/sdk`. | ||
| 2. Use the SDK to setup or interact with your chatbot. | ||
| 1. **Installation**: To integrate the SDK into your project, use npm: | ||
| ```bash | ||
| npm install @chatbotkit/sdk | ||
| ``` | ||
| 2. **Implementation**: Start using the SDK to build and manage your chatbot. | ||
|
|
||
| Here is a simple streaming example that works in Edge and Serverless environments: | ||
| ### Example: Streaming in Edge and Serverless Environments | ||
|
|
||
| ```js | ||
| Below is a straightforward example demonstrating how to implement streaming with the SDK in both Edge and Serverless environments: | ||
|
|
||
| ```javascript | ||
| import { ConversationClient } from '@chatbotkit/sdk/conversation/index.js' | ||
| // Initialize the ConversationClient | ||
| const client = new ConversationClient({ | ||
| /* configuration options */ | ||
| }) | ||
| // Stream messages using the ConversationClient | ||
| for await (const { type, data } of client | ||
| .complete(null, { model: 'gpt-4', messages }) | ||
| .stream()) { | ||
| if (type === 'token') { | ||
| process.stdout.write(data.token) | ||
| } | ||
| } | ||
| ``` | ||
| ## Examples | ||
| // Additional processing can be added here | ||
| ``` | ||
| You can find a wide-range of examples [here](https://github.com/chatbotkit/node-sdk/tree/main/examples). | ||
| Explore a detailed example with more advanced features [here](https://github.com/chatbotkit/node-sdk/tree/main/examples/sdk). | ||
| ## Documentation | ||
| For detailed documentation on available types, please refer to the [type documentation](https://github.com/chatbotkit/node-sdk/tree/main/docs). | ||
|
|
||
| Checkout the [ChatBotKit Documentation](https://chatbotkit.com/docs) for more information about the platform. | ||
| For an in-depth exploration of the ChatBotKit Node SDK, including insights into its capabilities and configurations for different environments, visit our [official documentation page](https://chatbotkit.github.io/node-sdk/modules/_chatbotkit_sdk.html). | ||
| ## 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](https://github.com/chatbotkit/node-sdk). | ||
| Encountered a bug or interested in contributing? Your participation is highly appreciated! Feel free to open an issue or submit a pull request on our [official GitHub repository](https://github.com/chatbotkit/node-sdk). |