Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-02 03:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
d99569f005
DocsGPT/extensions/react-widget
History
Alex 88b4fb8c2a Update API key in DocsGPTWidget.tsx
2024-04-01 11:25:31 +01:00
..
src Update API key in DocsGPTWidget.tsx 2024-04-01 11:25:31 +01:00
.gitignore shifted to parcel, styled-components 2024-03-05 21:15:58 +05:30
.parcelrc shifted to parcel, styled-components 2024-03-05 21:15:58 +05:30
custom.d.ts shifted to parcel, styled-components 2024-03-05 21:15:58 +05:30
package-lock.json purge unused deps, comments 2024-03-14 04:03:17 +05:30
package.json widget: version release 2024-03-14 16:58:57 +05:30
README.md adding fallback avatar 2024-03-06 01:58:52 +05:30
tsconfig.json shifted to parcel, styled-components 2024-03-05 21:15:58 +05:30

README.md

DocsGPT react widget

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

Installation

npm install  docsgpt

Usage

    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.'
             />;
    };

Our github

DocsGPT

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