CompanyBot

CompanyBot is an open-source plug-n-play knowledge companion for your company

Using Markprompt by Motif, train GPT models with your documentation/knowledge base and help customers get their queries answered with ease.

Check out the demo

Getting started

1. Setup Markprompt

Visit Markprompt

• Setup your account and create a project
• Upload your data in the Data section and start training
• Supported formats for your data are .mdx .md .txt .html

Read more about training your data here

2. Obtain project keys

• Once training is complete, head to the Settings section and add docs.setu.co in the Whitelisted domains section.

• Obtain the Production project key which will be used in the CompanyBot widget

3. Install the package

• npm

npm install @setu/company-bot

• yarn

yarn add @setu/company-bot

4. Import CompanyBot

// pages/_app.js

import { CompanyBot } from '@setu/company-bot';

export default function MyApp({ Component, pageProps }) {
  return (
    <>
      <CompanyBot projectKey="YOUR_PROJECT_KEY" />
      <Component {...pageProps} />
    </>
  );
}

Options

These options can be passed as props

| prop | type | description | default | required | | ------------- | ------ | ----------------------------------------------- | --------------------------------- | -------- | | name? | string | Name of the knowledge bot | CompanyBot | FALSE | | helperText? | string | Give more context about the bot | Get answers regarding our company | FALSE | | primaryColor? | string | Primary color of the bot | #CBD9E7 | FALSE | | projectKey | string | Production primary key obtained from Markprompt | N/A | TRUE |

Note: primaryColor should be passed as HEX code without the hash (#)

Example

Let's use

• #6B92BA as primaryColor

<CompanyBotWidget
  heading="TestBot"
  description="Ask any question and TestBot will help you"
  primaryColor="6B92BA"
  projectKey="XXXX-XXXX-XXXX-XXXX"
/>

You can play around with the bot in this demo

License

MIT. Have at it.