QAID Docs

Help Chat

QAID includes an AI-powered help assistant that answers questions about using the product based on official documentation.

Overview

Help Chat is a conversational assistant that:

  • Answers questions about QAID features, workflows, and configuration
  • Uses official user guide documentation as its knowledge base
  • Provides streaming responses with Markdown formatting
  • Is available to all authenticated users

Opening Help Chat

Chat Widget

The Help Chat appears as a floating button in the bottom-right corner of the application. Click it to open the chat panel.

Showing / Hiding

If the chat button isn't visible, it may be hidden:

  1. Click your profile avatar in the top-right corner
  2. Click "Show help chat" to make the widget visible
  3. Click "Hide help chat" to remove it from the screen

Your preference is saved in your browser and persists across sessions.

Using Help Chat

Asking Questions

  1. Click the chat button to open the panel
  2. Type your question in the input field (e.g., "How do I create a test plan?")
  3. Press Enter or click the Send button
  4. The assistant streams its response in real-time

What It Can Answer

Help Chat covers all topics in the QAID user guide:

  • Getting started — Creating projects, first steps
  • Page discovery — Crawling, page management, blacklisting
  • Element extraction — How elements are found and classified
  • Test generation — Scenarios, manual tests, recording
  • Test execution — Running test plans, viewing results
  • Visual regression — Baselines, comparisons, thresholds
  • API testing — Collections, requests, assertions
  • Settings — Configuration, auth profiles, environments
  • Troubleshooting — Common errors and solutions

What It Cannot Answer

The assistant only answers based on QAID documentation. It will not:

  • Answer questions outside the scope of the QAID user guide
  • Make up information not in the documentation

Conversation Context

The assistant remembers your previous messages within the current session. You can ask follow-up questions like "Tell me more about that" or "How do I do the second step?"

Note: Message history is stored in your browser only and is cleared when you refresh the page or close the browser tab. No messages are stored on the server.

Rate Limits

To manage costs, Help Chat has usage limits. If you hit a limit, you'll see a message explaining when you can try again or who to contact.

Admin Configuration

Administrators can configure Help Chat limits and availability under Admin > Settings (AI Configuration section). Options include:

  • Enabling or disabling Help Chat for the organization
  • Setting a monthly message cap
  • Setting a monthly AI cost cap

The admin panel shows current month usage at a glance.

Troubleshooting

Chat widget doesn't appear

  1. Hidden? — Open user dropdown and click "Show help chat"
  2. Disabled? — Admin may have disabled Help Chat. Contact your administrator.
  3. Not logged in? — Help Chat requires authentication

"Too many messages" error

You've hit your per-user rate limit. Wait and try again.

"Monthly message limit reached"

Your organization has hit the monthly message cap. Contact your administrator to increase the limit, or wait for the next month.

"Help chat is disabled by administrator"

An admin has turned off Help Chat. Contact your administrator.

Response seems incomplete or incorrect

The assistant answers strictly from the documentation. If the answer doesn't cover your question:

  • Try rephrasing with more specific terms
  • Check the relevant user guide section directly
  • Consult the FAQ or Troubleshooting guides

On this page