mirror of
https://github.com/arc53/DocsGPT.git
synced 2025-11-29 16:43:16 +00:00
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# DocsGPT react widget
|
|
|
|
|
|
This widget will allow you to embed a DocsGPT assistant in your React app.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install docsgpt
|
|
```
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
import { DocsGPTWidget } from "docsgpt";
|
|
|
|
const App = () => {
|
|
return <DocsGPTWidget />;
|
|
};
|
|
```
|
|
|
|
To link the widget to your api and your documents you can pass parameters to the <DocsGPTWidget /> component.
|
|
|
|
```javascript
|
|
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](https://github.com/arc53/DocsGPT)
|
|
|
|
You can find the source code in the extensions/react-widget folder.
|
|
|