Skip to content

QUICKSTART.md

Latest commit

 

History

History
125 lines (88 loc) · 3.82 KB

QUICKSTART.md

File metadata and controls

125 lines (88 loc) · 3.82 KB

Quick Start Guide

This guide will help you get started with the PathRAG application quickly.

Getting Started

Login

  1. Open the application in your browser
  2. Use one of the default accounts to log in:
    • Username: user1, Password: Pass@123
    • Username: user2, Password: Pass@123
    • Username: user3, Password: Pass@123
  3. Alternatively, you can register a new account by clicking "Register" on the login page

Dashboard

After logging in, you'll see the dashboard with an overview of:

  • Total chat conversations
  • Uploaded documents
  • Knowledge graph statistics

Using the Chat

  1. Click on "Chats" in the sidebar
  2. Type your question or message in the input field at the bottom
  3. Press Enter or click the send button
  4. The AI will respond based on the knowledge in the system
  5. You can scroll through your chat history

Chat Tips

  • Ask specific questions for more accurate responses
  • Reference documents you've uploaded for context-specific answers
  • Try multi-hop questions that require connecting information across documents
  • The AI uses the knowledge graph to provide more comprehensive responses

Example Questions

Simple questions:

  • "What are the main features of PathRAG?"
  • "How does PathRAG compare to traditional RAG systems?"

Complex questions:

  • "What techniques developed by researchers at Stanford have been applied to knowledge graph construction?"
  • "How do the approaches used in PathRAG relate to earlier work on knowledge representation?"

Working with Documents

  1. Click on "Documents" in the sidebar
  2. Click the "Upload Document" button
  3. Drag and drop a file or click to select a file
    • Supported formats: PDF, DOCX, MD
  4. The document will upload and be processed automatically
  5. You'll see the upload progress in real-time
  6. Once processed, the document will appear in the list

Document Management Tips

  • Larger documents may take longer to process
  • The system extracts entities and relationships from documents to build the knowledge graph
  • After uploading documents, you can ask questions about them in the chat
  • Upload related documents to create a richer knowledge graph with more connections

Exploring the Knowledge Graph

  1. Click on "Knowledge Graph" in the sidebar
  2. You'll see a visualization of the knowledge graph
    • Nodes represent entities (people, organizations, concepts, etc.)
    • Edges represent relationships between entities
  3. You can:
    • Drag nodes to rearrange the graph
    • Zoom in/out using the mouse wheel
    • Hover over nodes to see details
  4. Use the search box to query specific parts of the knowledge graph

Knowledge Graph Tips

  • Different colors represent different entity types
  • The thickness of connections indicates the strength of relationships
  • Try specific queries to focus on particular areas of knowledge

Mobile Usage

The application is fully responsive and works on mobile devices:

  1. Access the same URL on your mobile browser
  2. Log in with your credentials
  3. Use the menu button to access the sidebar
  4. All features work the same as on desktop

PWA Installation

You can install the application as a Progressive Web App (PWA):

On Desktop (Chrome)

  1. Click the install icon in the address bar
  2. Follow the prompts to install

On Mobile (Android)

  1. Tap the menu button in your browser
  2. Select "Add to Home Screen" or "Install App"
  3. Follow the prompts

On iOS

  1. Tap the share button
  2. Select "Add to Home Screen"
  3. Tap "Add"

Keyboard Shortcuts

  • Enter: Send a message in chat
  • Shift + Enter: Add a new line in the chat input
  • Esc: Close modals

Getting Help

If you encounter any issues:

  1. Check the README.md file for detailed documentation
  2. Refer to the INSTALLATION.md for setup troubleshooting
  3. Contact the system administrator for account-related issues