Integrating DocsGPT Chat Widget

Introduction

The DocsGPT Widget is a powerful tool that allows you to integrate AI-driven document assistance directly into your web applications. This guide will walk you through embedding the DocsGPT Widget into your projects, whether you're using React, plain HTML, or Nextra. Enhance your user experience by providing seamless access to intelligent document search and chatbot capabilities.

Try out the interactive widget showcase and customize its parameters at the DocsGPT Widget Demo (opens in a new tab).

Setup

Installation

Make sure you have Node.js and npm (or yarn, pnpm) installed in your project. Navigate to your project directory in the terminal and install the docsgpt package:

npm install docsgpt

Usage

In your React component file, import the DocsGPTWidget component:

import { DocsGPTWidget } from "docsgpt";

Now, you can embed the widget within your React component's JSX:

<DocsGPTWidget
  apiHost="https://your-docsgpt-api.com"
  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."
  theme="dark"
  buttonIcon="https://your-icon"
  buttonBg="#222327"
/>

Properties Table

The DocsGPT Widget offers a range of customizable properties that allow you to tailor its appearance and behavior to perfectly match your web application. These parameters can be modified directly when embedding the widget in your React components or HTML code. Below is a detailed overview of each available prop:

Prop	Type	Default Value	Description
`apiHost`	`string`	`"https://gptcloud.arc53.com"`	Required. The URL of your DocsGPT API backend. This endpoint handles vector search and chatbot queries.
`apiKey`	`string`	`"your-api-key"`	API key for authentication with your DocsGPT API. Leave empty if no authentication is required.
`avatar`	`string`	`dino-icon-link` (opens in a new tab)	URL for the avatar image displayed in the chatbot interface.
`title`	`string`	`"Get AI assistance"`	Title text shown in the chatbot header.
`description`	`string`	`"DocsGPT's AI Chatbot is here to help"`	Sub-title or descriptive text displayed below the title in the chatbot header.
`heroTitle`	`string`	`"Welcome to DocsGPT !"`	Welcome message displayed when the chatbot is initially opened.
`heroDescription`	`string`	`"This chatbot is built with DocsGPT and utilises GenAI, please review important information using sources."`	Introductory text providing context or disclaimers about the chatbot.
`theme`	`"dark" \| "light"`	`"dark"`	Color theme of the widget interface. Options: `"dark"` or `"light"`. Defaults to `"dark"`.
`buttonIcon`	`string`	`"https://your-icon"`	URL for the icon image used in the widget's launch button.
`buttonBg`	`string`	`"#222327"`	Background color of the widget's launch button.
`size`	`"small" \| "medium"`	`"medium"`	Size of the widget. Options: `"small"` or `"medium"`. Defaults to `"medium"`.

Notes on Widget Properties

Full Customization: Every property listed in the table can be customized. Override the defaults to create a widget that perfectly matches your branding and application context. From avatars and titles to color schemes, you have fine-grained control over the widget's presentation.
API Key Handling: The apiKey prop is optional. Only include it if your DocsGPT backend API is configured to require API key authentication. apiHost for DocsGPT Cloud is https://gptcloud.arc53.com/

Explore and Customize Further

The DocsGPT Widget is fully open-source, allowing for deep customization and extension beyond the readily available props.

The complete source code for the React-based widget is available in the extensions/react-widget directory within the main DocsGPT GitHub Repository (opens in a new tab). Feel free to explore the code, fork the repository, and tailor the widget to your exact requirements.

🗂️️ API-docs