TuanMinhajSeedin commited on
Commit
416bbd5
·
verified ·
1 Parent(s): 99ca283

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +45 -2
README.md CHANGED
@@ -3,8 +3,7 @@ title: Transportation Guidance System
3
  emoji: 🚌
4
  colorFrom: blue
5
  colorTo: green
6
- sdk: streamlit # or gradio, or docker depending on what you’re using
7
- sdk_version: "1.36.0" # put the version you need
8
  app_file: app.py
9
  pinned: false
10
  ---
@@ -13,3 +12,47 @@ pinned: false
13
 
14
  This project provides a smart assistant for public and private transportation in Sri Lanka.
15
  It integrates schedules, routes, and hire requests into a searchable knowledge graph.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  emoji: 🚌
4
  colorFrom: blue
5
  colorTo: green
6
+ sdk: docker
 
7
  app_file: app.py
8
  pinned: false
9
  ---
 
12
 
13
  This project provides a smart assistant for public and private transportation in Sri Lanka.
14
  It integrates schedules, routes, and hire requests into a searchable knowledge graph.
15
+
16
+ ## 🌟 Features
17
+
18
+ - **Natural Language Processing**: Advanced NLP for understanding transport queries
19
+ - **Multilingual Support**: Sinhala-English translation with LLM integration
20
+ - **Spell Correction**: Fuzzy matching and LLM-based location correction
21
+ - **Neo4j Integration**: Graph database for efficient route and fare queries
22
+ - **Enhanced Query Types**: Support for comparisons, ranges, recommendations
23
+ - **RESTful API**: Comprehensive API endpoints for all functionality
24
+
25
+ ## 🚀 Quick Start
26
+
27
+ ### API Endpoints
28
+
29
+ - `GET /` - Main page
30
+ - `POST /api/query` - Process natural language transport queries
31
+ - `GET /api/status` - System status and statistics
32
+ - `GET /api/health` - Health check
33
+ - `GET /api/places` - Get all available places
34
+ - `GET /api/examples` - Get example queries
35
+
36
+ ### Example Queries
37
+
38
+ **English:**
39
+ - "What is the fare from Colombo to Kandy?"
40
+ - "Show me routes from Galle to Matara"
41
+ - "Compare fares from Colombo to Panadura and Colombo to Galle"
42
+
43
+ **Sinhala:**
44
+ - "කොළඹ සිට මහනුවරට ගාස්තුව කීයද?"
45
+ - "ගාල්ල සිට මාතර දක්වා මාර්ග පෙන්වන්න"
46
+
47
+ ## 🔧 Configuration
48
+
49
+ Set these environment variables in your Hugging Face Space settings:
50
+
51
+ ```
52
+ OPENAI_API_KEY=your_openai_api_key
53
+ NEO4J_URI=your_neo4j_uri
54
+ NEO4J_USER=your_neo4j_user
55
+ NEO4J_PASSWORD=your_neo4j_password
56
+ FORCE_LLM_TRANSLATION=true
57
+ LOG_LEVEL=INFO
58
+ ```