Skip to content

Integrating a User Friendly Help Section(FAQ) and Chatbot (Backend)#395

Merged
Eyantra698Sumanto merged 2 commits intoFOSSEE:eSim-AI-Based-Debugging-Tool-Rudrafrom
Rudramani1:eSim-AI-Based-Debugging-Tool
Sep 19, 2025
Merged

Integrating a User Friendly Help Section(FAQ) and Chatbot (Backend)#395
Eyantra698Sumanto merged 2 commits intoFOSSEE:eSim-AI-Based-Debugging-Tool-Rudrafrom
Rudramani1:eSim-AI-Based-Debugging-Tool

Conversation

@Rudramani1
Copy link
Copy Markdown


📘 User Manual UI Enhancements

UserManual.py & UI Integration:

  • Added a new dockable widget for the User Manual under the "Help Section" (DockArea.py).
  • Integrated multiple tabs:
    • FAQs
    • PDF Manual
    • Support Chat
  • Enhanced FAQ section with:
    • Expandable Q&A widgets
    • Live search/filter bar
  • Enabled opening PDF user manual in-app or via a new window.
  • Applied custom CSS for better readability and user experience.

🔧 Backend Changes

HelpBot.py:

  • Implemented user session management using Flask with secure secret keys.
  • Integrated langchain_ollama for chatbot functionality.
  • Added thread-safe user handling with a UserManager class to manage user data and activity history.
  • Configured session timeout and maximum message history per user to support scalability.
  • Enhanced chatbot response accuracy via vector-based semantic search using langchain_chroma.

Vector.py:

  • Created a vector database using Chroma and OllamaEmbeddings for semantic search.
  • Indexed esim_help.csv for efficient document retrieval.
  • Optimized vector store initialization and persistence for better performance and faster lookups.

Related Issues

  • Resolves session handling and chatbot integration issues.
  • Improves accessibility and usability of the in-app help and documentation.

Purpose

  • Provide a robust backend for managing sessions and intelligent chatbot interactions.
  • Enable semantic search for faster, more relevant help content retrieval.
  • Improve user experience by embedding an intuitive, searchable help section into the app.

Approach

  • Used Flask for session tracking.
  • Integrated LangChain with Chroma vector store for context-aware chatbot responses.
  • Designed an interactive, tabbed user manual interface with styling for clarity and ease of use.

📝 Usage Hints

  • To make the chatbot functional:

    1. Host the Backend/ folder on a server.
    2. Run HelpBot.py.
    3. Copy the server URL and paste it into src/browser/main.py where the chatbot URL is defined.
  • To add more FAQs, simply update the .csv files in:

resources/esim_faq.csv

@Eyantra698Sumanto Eyantra698Sumanto changed the base branch from eSim-AI-Based-Debugging-Tool to eSim-AI-Based-Debugging-Tool-Rudramani September 19, 2025 14:12
@Eyantra698Sumanto Eyantra698Sumanto changed the base branch from eSim-AI-Based-Debugging-Tool-Rudramani to eSim-AI-Based-Debugging-Tool-Rudra September 19, 2025 14:14
@Eyantra698Sumanto Eyantra698Sumanto merged commit f4efbdb into FOSSEE:eSim-AI-Based-Debugging-Tool-Rudra Sep 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants