Skip to main content

Knowledge Base

Train your AI assistant with your product documentation using the Knowledge Base.

Overview​

The Knowledge Base stores documentation sources that the AI uses to answer user questions. Deway indexes your content, enabling accurate, context-aware responses grounded in your actual documentation.

Navigate to Knowledge Base in the admin sidebar to manage your data sources.

Data Sources​

The Knowledge Base supports two types of data sources:

TypeDescription
Web ScrapeDocumentation websites crawled and indexed by the Deway team
ManualPDF files you upload directly

Data Sources Table​

The Knowledge Base page shows all your data sources in a table:

ColumnDescription
SourceURL (for web scrapes) or filename (for manual uploads)
TypeWeb Scrape or Manual
StatusCurrent sync state
DocumentsNumber of pages/documents indexed
Last UpdatedWhen the source was last synced

Sync Status​

StatusDescription
CompletedSource has been indexed successfully
SyncingCurrently being processed
FailedIndexing encountered an error

Uploading Files​

You can upload PDF documents directly to your Knowledge Base.

How to Upload​

  1. Navigate to Knowledge Base
  2. Click Upload File
  3. Drag and drop a PDF file, or click to browse
  4. Click Upload File to start processing

Requirements​

  • File format: PDF only
  • Max file size: 5 MB
  • Processing begins immediately after upload
  • The status will show "Syncing" while the file is being indexed

Use Cases​

  • Internal documentation not available on a public URL
  • Product guides and training materials
  • Policy documents and FAQs
  • API reference PDFs

Web Scrape Sources​

Web scrape sources are set up by the Deway team during onboarding. These are your public documentation sites (help centers, docs sites, API references) that Deway crawls and indexes.

To add or update a web scrape source, contact the Deway team.

Best Practices​

Start with Core Documentation​

  1. Ensure your main documentation is indexed
  2. Verify the AI can answer basic product questions
  3. Upload supplemental PDFs for gaps

Keep Sources Current​

  • Re-sync after major documentation updates
  • The AI's answers are only as good as the indexed content
  • Upload updated PDFs when internal docs change

Monitor Quality​

Use the Chats page to:

  • Check if the AI cites the right sources
  • Find questions the AI can't answer (gaps in your Knowledge Base)
  • Identify outdated content that needs refreshing

Multiple Data Sources​

You can have multiple sources. Common setups:

SourceType
Product DocsWeb Scrape
API ReferenceWeb Scrape
Internal GuidesManual (PDF)
Onboarding PlaybookManual (PDF)

Each source is indexed independently and combined in the AI's knowledge.

Troubleshooting​

Upload Failed​

  1. Verify the file is a valid PDF
  2. Check the file is under 5 MB
  3. Try uploading again

AI Gives Incorrect Answers​

  1. Check if the relevant source is indexed (document count > 0)
  2. Verify the source status is "Completed"
  3. Upload additional documentation to fill gaps
  4. Contact the Deway team if web scrape sources need updating

Next Steps​