Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-05 21:21:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
d8720d0849
DocsGPT/extensions/react-widget/README.md
ilyasosman d8720d0849 Add DocsGPTWidget embedding support for HTML
2024-05-19 22:08:18 +03:00

2.7 KiB
Raw Blame History

DocsGPT react widget

This widget will allow you to embed a DocsGPT assistant in your React app.

Installation

npm install  docsgpt

Usage

React

    import { DocsGPTWidget } from "docsgpt";

    const App = () => {
      return <DocsGPTWidget />;
    };

To link the widget to your api and your documents you can pass parameters to the component.

    import { DocsGPTWidget } from "docsgpt";

    const App = () => {
      return <DocsGPTWidget
             apiHost = 'http://localhost:7001',
             selectDocs = 'default',
             apiKey = '',
             avatar = 'https://d3dg1063dc54p9.cloudfront.net/cute-docsgpt.png',
             title = 'Get AI assistance',
             description = 'DocsGPT\'s AI Chatbot is here to help',
             heroTitle = 'Welcome to DocsGPT !',
             heroDescription='This chatbot is built with DocsGPT and utilises GenAI, please review important information using sources.'
             />;
    };

Html

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <title></title>
      </head>
      <body>
        <div id="widget-container"></div>
        <!-- Include the widget script -->
        <script src="path/to/your/dist/main.js" type="module"></script>
        <script type="module">
          window.onload = function() {
            renderDocsGPTWidget('widget-container');
          }
        </script>
      </body>
    </html>

To link the widget to your api and your documents you can pass parameters to the renderDocsGPTWidget('div id', { parameters }).

    <!DOCTYPE html>
    <html lang="en">
      <head>
        <title></title>
      </head>
      <body>
        <div id="widget-container"></div>
        <!-- Include the widget script -->
        <script src="path/to/your/dist/main.js" type="module"></script>
        <script type="module">
          window.onload = function() {
            renderDocsGPTWidget('widget-container', , {
              apiHost: 'http://localhost:7001',
              selectDocs: 'default',
              apiKey: '',
              avatar: 'https://d3dg1063dc54p9.cloudfront.net/cute-docsgpt.png',
              title: 'Get AI assistance',
              description: "DocsGPT's AI Chatbot is here to help",
              heroTitle: 'Welcome to DocsGPT !',
              heroDescription: 'This chatbot is built with DocsGPT and utilises GenAI, please review important information using sources.'
            });
          }
        </script>
      </body>
    </html>

Our github

DocsGPT

You can find the source code in the extensions/react-widget folder.