Skip to main content

FAQ Generator

The FAQ Generator analyzes conversation history to identify frequently asked questions and automatically creates cached responses for them.

What It Doesโ€‹

The FAQ Generator:

  1. Queries your conversation history
  2. Finds questions asked multiple times
  3. Filters by success rate (good feedback)
  4. Generates high-quality cached responses
  5. Stores them for instant retrieval

Key Pointโ€‹

Automatic Caching Exists

Your system has automatic caching that runs continuously. The FAQ Generator is an optional optimization tool for pre-populating cache or bulk processing. Your chatbot works perfectly without manually running this.

When to Useโ€‹

Good Times to Runโ€‹

  • Initial setup: Pre-populate cache with common questions
  • After content updates: Generate caches for new material
  • Semester start: Prepare for anticipated questions
  • Low cache hit rate: Improve coverage

Skip Ifโ€‹

  • Cache hit rate is already good
  • System is performing well
  • You've recently run it

Configuration Optionsโ€‹

Limit (Top N Questions)โ€‹

How many top questions to process, ordered by frequency.

ValueUse Case
10-25Quick test or targeted caching
50Standard run (recommended)
100+Comprehensive caching

Recommendation: Start with 50 for initial runs.

Min Times Askedโ€‹

Only cache questions asked at least this many times.

ValueEffect
1Cache everything (not recommended)
2Cache repeat questions (default)
5+Only very common questions

Recommendation: Use 2-3 to ensure genuine demand.

Min Success Rateโ€‹

Success rate = positive feedback / total feedback. Only caches questions with good user satisfaction.

ValueMeaning
0.330% positive - includes mixed questions
0.550% positive - balanced (default)
0.770% positive - high quality only

Recommendation: Use 0.5 for balanced results.

How to Useโ€‹

Step 1: Configure Settingsโ€‹

  1. Set Limit to your desired number (start with 50)
  2. Set Min Times Asked (default 2 is good)
  3. Set Min Success Rate (default 0.5 is good)

Step 2: Run Dry Run Firstโ€‹

  1. Click Dry Run (Preview)
  2. Review the output panel
  3. See which questions would be cached
  4. Verify the numbers look reasonable

Step 3: Generate FAQsโ€‹

  1. If dry run looks good, click Generate FAQs
  2. Watch the progress in the output panel
  3. Review results when complete

Understanding the Outputโ€‹

The output panel shows:

๐Ÿ“Š Results:
Questions analyzed: 50
Successfully cached: 35
Skipped (low quality): 10
Failed: 5

๐Ÿ“ Details:
- Cached: "What is HFIM?" (asked 25 times)
- Skipped: "random question" (low success rate)
...

Result Categoriesโ€‹

CategoryMeaning
Questions analyzedTotal questions reviewed
Successfully cachedNew cache entries created
SkippedDidn't meet quality threshold
FailedError during generation

After Runningโ€‹

Verify Resultsโ€‹

  1. Go to Cache Management
  2. Sort by "Created Date" descending
  3. Review newly created entries
  4. Edit any that need improvement

Monitor Performanceโ€‹

  • Check Analytics over the next week
  • Look for improved cache hit rate
  • Note which generated entries are being used

Best Practicesโ€‹

Start Conservativeโ€‹

  • Use smaller limits first (25-50)
  • Use higher success rate threshold (0.5-0.7)
  • Expand after reviewing results

Review Generated Contentโ€‹

  • Generated answers may need refinement
  • Check sources are accurate
  • Add variations to improve matching

Don't Over-Generateโ€‹

  • Running repeatedly doesn't help
  • Wait between runs to accumulate new data
  • Focus on quality over quantity

Troubleshootingโ€‹

No Questions Foundโ€‹

  • Check your min times asked setting
  • Try a larger time window
  • Verify conversations exist in the database

Low Success Rateโ€‹

  • Your feedback data may be limited
  • Lower the min success rate threshold
  • Or wait for more user feedback

Many Skippedโ€‹

  • Quality threshold may be too high
  • Lower min success rate if appropriate
  • Check conversation quality

Generation Failedโ€‹

  • Check the error messages
  • May indicate API issues
  • Try again later

Related: