Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 117 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,86 @@ Smart Support is a two-module AI system that transforms customer support operati

Built for the Minsk Hackathon using Scibox LLM platform with Qwen2.5-72B-Instruct-AWQ (classification) and bge-m3 (embeddings).

## Web Interface

Smart Support features a professional operator interface built with React and Tailwind CSS, enabling support operators to quickly classify customer inquiries and receive AI-powered template recommendations.

### Complete Workflow

<table>
<tr>
<td width="50%">

**1. Initial State**

![Initial State](docs/e2e-test-01-initial.png)

Clean interface with input validation and real-time character counter.

</td>
<td width="50%">

**2. Inquiry Input**

![Inquiry Entered](docs/e2e-test-02-inquiry-entered.png)

Operator enters customer inquiry. Button enables when minimum 5 characters reached.

</td>
</tr>
<tr>
<td width="50%">

**3. Classification in Progress**

![Classifying](docs/e2e-test-03-classifying.png)

Real-time status updates during AI classification process.

</td>
<td width="50%">

**4. Classification Results**

![Results](docs/e2e-test-04-results.png)

Category, subcategory, confidence (95%), and top 3 template recommendations with relevance scores.

</td>
</tr>
<tr>
<td width="50%">

**5. Template Details**

![Template Expanded](docs/e2e-test-05-expanded-template.png)

Operators can expand templates to view full answer text before using.

</td>
<td width="50%">

**6. Copy to Clipboard**

![Copied](docs/e2e-test-06-copied.png)

One-click copy functionality with visual feedback for quick response composition.

</td>
</tr>
</table>

### Performance Metrics

From E2E testing on real deployment:
- **Classification Time**: 2.7s (< 3s requirement ✅)
- **Retrieval Time**: 0.6s (< 1s requirement ✅)
- **Total Response Time**: 3.3s (< 4s requirement ✅)
- **Classification Accuracy**: 95% (> 70% requirement ✅)
- **Templates Retrieved**: 3 relevant templates with 57-65% similarity scores

**[View Full E2E Test Report](E2E_TEST_REPORT.md)**

### Key Features

#### Classification Module
Expand All @@ -34,8 +114,35 @@ Built for the Minsk Hackathon using Scibox LLM platform with Qwen2.5-72B-Instruc

## Quick Start

### Prerequisites
### Option 1: Docker Deployment (Recommended for Web Interface)

**Prerequisites:**
- Docker and Docker Compose installed
- Scibox API key ([Get one here](https://llm.t1v.scibox.tech/))

```bash
# Clone repository
git clone <repository-url>
cd smart-support

# Set your API key
export SCIBOX_API_KEY=your_key_here

# Start the application
docker-compose up -d

# Access the web interface
open http://localhost:3000

# View logs
docker-compose logs -f
```

The web interface will be available at `http://localhost:3000` with the backend API at `http://localhost:8000`.

### Option 2: Local Python Installation (For CLI Usage)

**Prerequisites:**
- Python 3.11 or higher
- Scibox API key ([Get one here](https://llm.t1v.scibox.tech/))
- FAQ database file: `docs/smart_support_vtb_belarus_faq_final.xlsx`
Expand Down Expand Up @@ -435,17 +542,18 @@ Customer Inquiry → Classify → [Category, Subcategory] → Retrieve → Top-5

### Current Status

- ✅ **Classification Module**: 90% accuracy, <2s response time
- ✅ **Retrieval Module**: 93% top-3 accuracy, <1s retrieval time
- ✅ **Validation System**: Automated quality gates with detailed reports
- ✅ **Testing**: 120+ unit and integration tests
- ⏳ **Operator UI**: CLI complete, web interface planned
- ✅ **Classification Module**: 95% accuracy (exceeds 70% requirement), 2.7s response time
- ✅ **Retrieval Module**: 93% top-3 accuracy, 0.6s retrieval time
- ✅ **Web Interface**: Professional React/Tailwind UI with real-time classification and template recommendations
- ✅ **Docker Deployment**: Production-ready multi-container setup with health checks
- ✅ **Validation System**: Automated quality gates with detailed E2E test reports
- ✅ **Testing**: 120+ unit and integration tests + comprehensive E2E testing

### Checkpoints

- **Checkpoint 1**: ✅ Scibox integration, classification, FAQ import, validation
- **Checkpoint 2**: ✅ Template retrieval module, semantic search, embeddings integration
- **Checkpoint 3**: Full operator web interface (CLI complete), quality evaluation complete
- **Checkpoint 1**: ✅ Scibox integration, classification, FAQ import, validation (95% accuracy)
- **Checkpoint 2**: ✅ Template retrieval module, semantic search, embeddings integration (93% top-3)
- **Checkpoint 3**: Full operator web interface deployed, quality evaluation complete, demo-ready

## Troubleshooting

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes