1.0.9 • Published 2 years ago
arneo-bot v1.0.9
Custom Chatbot - Experimental
Description
This package is a scafolding to create a custom chatbot using OpenAI Api. It is still in development and not ready to be used in production.
Requirements
You need an OpenAI Api key to use this package. You can get one here.
Installation
Follow the steps below to install the package.
npm install
npm run dev
Parameters
Adjust parameters of your chatbot in the main.js file.
const chat = new siteBot({
apiKey: "OPEN_AI_API_KEY",
name: "Test AI",
description: "test",
welcomeMessage: "Please don't use me in Prod",
context: ``,
color: "#5426b1",
icon: 'https://cdn.dribbble.com/userupload/11557287/file/original-256bc5a3829747ce376fbd5b33ea83ce.jpg?resize=2048x1536'
});
All parameters
Parameter | Description | Default | Type |
---|---|---|---|
apiKey | OpenAI Api Key | null | string |
name | Name of the chatbot | null | string |
description | Description of the chatbot | null | string |
welcomeMessage | Welcome message of the chatbot | null | string |
context | Context of the chatbot | null | string |
color | Color of the chatbot | null | string |
icon | Icon of the chatbot | null | string |
Usage
For building the package for 'npm publish' use the following command.
npm run build