Spaces:
Runtime error
Runtime error
File size: 27,996 Bytes
c82eae9 9e6cbd4 c82eae9 9e6cbd4 c82eae9 9e6cbd4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 | ---
title: Music Store Multi-Agent Support
emoji: π΅
colorFrom: blue
colorTo: indigo
sdk: gradio
sdk_version: 5.29.0
python_version: "3.12"
app_file: app.py
pinned: false
---
# Multi-Agent Customer Support System
A production-grade, **LangGraph-powered hierarchical multi-agent assistant** for a digital music store. It combines a **Supervisor router**, two specialized **ReAct sub-agents** (music catalog + invoice information), **human-in-the-loop identity verification**, **long-term per-customer memory**, and a **Gradio chat UI** - all backed by a real relational schema (the Chinook sample database).
**Live Demo:** [huggingface.co/spaces/animeshkcm/Multi-Agent-Customer-Support](https://huggingface.co/spaces/animeshkcm/Multi-Agent-Customer-Support)
---
## Capstone Framing
This project is designed as an advanced AI engineering capstone, going beyond a simple agent or tool-calling demo. It represents a fully assembled multi-agent AI system incorporating structured state management, persistent memory, safety controls, deterministic execution, and real-world data integration. Each architectural decision such as grounding rules, memory merge semantics, supervisor-based routing, verification gating, and deterministic SQL generation directly addresses known failure modes observed in production-scale LLM systems.
### Problem Statement
Customer support for a catalog-and-billing business has two opposing requirements:
1. **Conversational flexibility** - customers ask in free-form natural language (βwhat's my most expensive track?β, βany rock albums from AC/DC?β).
2. **Operational correctness** - invoice totals, track IDs, and customer accounts must be exact, auditable, and access-controlled.
A single LLM with a single system prompt cannot satisfy both: it will either hallucinate when asked for unavailable data, or leak account data across customers, or route off-topic questions to SQL tools. This project solves that gap with a **hierarchical agent graph** where each responsibility is isolated into its own node.
### Business Use Case
A digital music store with **59 customers**, **412 invoices**, **3,503 tracks**, **275 artists**, and **25 genres** (Chinook dataset). The assistant supports three user journeys:
| Journey | Entry Point | Guardrails |
|---|---|---|
| **Catalog discovery** (anonymous) | Any music question | Tool-grounded only; no PII access |
| **Account lookup** (identified) | Customer ID, email, or phone | Human-in-the-loop verification before any invoice tool runs |
| **Personalized recall** (returning) | Verified customer | Music preferences persisted across sessions, merge-only, never deleted |
### Why This Matters for AI Engineers
The project exercises the full surface area an AI engineer ships in production:
- **Graph-native orchestration** (not a flat ReAct loop) with conditional edges, interrupts, and a supervisor router.
- **Typed shared state** (`TypedDict` + `add_messages` reducer) instead of ad-hoc dicts.
- **Structured LLM output** (Pydantic schemas) for identifier extraction and preference capture - no regex parsing of model text.
- **Prompt engineering as a contract**: every sub-agent prompt enforces explicit grounding, exact quoting, and scope boundaries.
- **Deterministic SQL under an LLM** (CTE + `ROW_NUMBER()`) so the same question returns the same answer.
- **Two memory modes**: short-term per-thread (`MemorySaver` checkpointer) and long-term per-customer (`InMemoryStore`).
- **Streaming execution** via `graph.stream(..., stream_mode="updates")` wired to a Gradio chat UI with live status and interrupt handling.
### Technical Complexity
| Dimension | What's hard | How it's solved |
|---|---|---|
| **Routing** | Music vs invoice vs mixed vs off-topic | `langgraph-supervisor` with explicit routing rules in the system prompt |
| **Identity** | Accept ID / email / phone in free text without trusting user-extracted IDs downstream | Pydantic `UserInput` + DB lookup; verified `customer_id` is injected via `SystemMessage` only |
| **Hallucination** | LLMs invent albums, prices, totals | Tool-only responses enforced in every prompt; "I could not findβ¦" fallback wording is scripted |
| **Determinism** | `LIMIT 10` on a genre returns different artists each call | `ROW_NUMBER() OVER (PARTITION BY ArtistId ORDER BY TrackId)` CTE β stable sample |
| **Memory merge** | LLM summarization can erase prior preferences | Set-union on `music_preferences`; empty output is ignored if existing memory exists |
| **Interrupts** | Verification needs a second user turn without losing graph state | LangGraph `interrupt()` + thread-scoped checkpointer; UI reads `snapshot.next` to detect pause |
| **SQL safety** | LLM-driven inputs could inject SQL | 100% parameterized via SQLAlchemy `text()` bindings; `_safe_int()` on all numeric args |
### The Engineering Challenge
The hardest part was **not** building any one agent. It was composing them so:
1. The supervisor cannot bypass verification.
2. The music agent cannot read invoices.
3. The invoice agent cannot guess a customer ID from the conversation.
4. Memory writes cannot erase prior data.
5. The whole thing is observable (every tool call is logged with input and output length) and testable (28 pytest tests over tools + DB).
Those constraints are what turn "LLM + tools" into a **system**.
---
## System Architecture
### High Level System Architecture
```mermaid
flowchart TD
User([User])
UI[Gradio Chat UI<br/>src/ui/app.py]
Graph[Multi-Agent Graph<br/>src/agents/graph.py]
subgraph Outer[Outer Graph - Orchestration]
Verify[verify_info]
Human[human_input<br/>interrupt]
Load[load_memory]
Save[create_memory]
end
Sup[Supervisor<br/>langgraph-supervisor]
subgraph Music[Music Catalog Sub-Agent]
MA[music_assistant<br/>ReAct]
MT[music_tool_node<br/>5 tools]
end
subgraph Invoice[Invoice Sub-Agent]
IR[create_react_agent<br/>4 tools]
end
DB[(Chinook SQLite<br/>in-memory)]
Store[(InMemoryStore<br/>per-customer memory)]
Ckpt[(MemorySaver<br/>per-thread history)]
User -->|message| UI
UI -->|graph.stream| Graph
Graph --> Verify
Verify -->|no customer_id| Human
Human --> Verify
Verify -->|verified| Load
Load --> Sup
Sup --> MA
Sup --> IR
MA <--> MT
MT --> DB
IR --> DB
Sup --> Save
Load --> Store
Save --> Store
Graph -. checkpoints .- Ckpt
Graph -->|final AIMessage| UI
UI --> User
```
### Agent Workflow
```mermaid
flowchart LR
Q[User Query] --> Sup[Supervisor]
Sup -->|music / catalog| M[Music Agent]
Sup -->|invoice / billing| I[Invoice Agent]
Sup -->|mixed| Both[Invoice first, then Music]
Sup -->|off-topic| Reject[Direct Refusal]
M -->|reason| M1[Pick Tool]
M1 -->|act| M2[Run SQL]
M2 -->|observe| M
M -->|done| R1[Music Answer]
I -->|reason| I1[Pick Tool]
I1 -->|act| I2[Run SQL]
I2 -->|observe| I
I -->|done| R2[Invoice Answer]
R1 --> Merge[Supervisor Merge]
R2 --> Merge
Both --> Merge
Reject --> Merge
Merge --> Out[Final Response]
```
---
## Pipeline Overview
End-to-end lifecycle of a single user turn:
```mermaid
flowchart LR
A[1. User Types] --> B[2. UI Streams to Graph]
B --> C[3. Verify Identity]
C -->|found| D[4. Load Memory]
C -->|not found| C2[3a. Interrupt + Ask]
C2 --> C
D --> E[5. Supervisor Routes]
E --> F[6. Sub-Agent ReAct Loop]
F --> G[7. SQL via Parameterized Query]
G --> F
F --> H[8. Merge Sub-Agent Outputs]
H --> I[9. Update Memory]
I --> J[10. Render Response in UI]
```
Each stage is implemented as a distinct LangGraph node. No stage can be skipped; no stage can run out of order. The checkpointer snapshots state after every node so an interrupt can resume exactly where it paused.
---
## LangGraph State Machine
The outer graph is a strict finite state machine. It always enters at `verify_info` and always exits via `create_memory`.
```mermaid
stateDiagram-v2
[*] --> verify_info
verify_info --> human_input: should_interrupt == interrupt<br/>(customer_id is None)
human_input --> verify_info: user provides identifier
verify_info --> load_memory: should_interrupt == continue<br/>(customer_id set)
load_memory --> supervisor: preferences injected
supervisor --> create_memory: sub-agents returned
create_memory --> [*]
```
**Shared state** (`src/state.py`):
```python
class State(TypedDict):
customer_id: Optional[str]
messages: Annotated[list[AnyMessage], add_messages]
loaded_memory: str
remaining_steps: RemainingSteps
```
**Supervisor subgraph** (built by `langgraph-supervisor.create_supervisor`) dispatches to one of the sub-agents and merges their responses into `messages` via the `add_messages` reducer.
**Music sub-agent subgraph** (hand-built, `src/agents/graph.py`):
```mermaid
stateDiagram-v2
[*] --> music_assistant
music_assistant --> music_tool_node: should_continue == continue<br/>(has tool_calls)
music_tool_node --> music_assistant
music_assistant --> [*]: should_continue == end<br/>(no tool_calls)
```
**Invoice sub-agent** is built via `langgraph.prebuilt.create_react_agent` - same pattern, wrapped for you.
---
## Data Flow
```mermaid
flowchart LR
subgraph Input
U[User Message]
end
subgraph State
S[State TypedDict<br/>customer_id Β· messages<br/>loaded_memory]
end
subgraph Agents
V[verify_info<br/>structured LLM + DB]
LM[load_memory<br/>Store read]
SUP[Supervisor LLM]
MUS[Music ReAct]
INV[Invoice ReAct]
CM[create_memory<br/>structured LLM + Store write]
end
subgraph Tools
T1[5 music_tools]
T2[4 invoice_tools]
end
subgraph Data
DB[(Chinook SQLite)]
STORE[(InMemoryStore)]
CKPT[(MemorySaver)]
end
subgraph Output
R[AIMessage]
UI2[Gradio Chatbot]
end
U --> S
S --> V
V --> DB
V --> S
S --> LM
LM --> STORE
LM --> S
S --> SUP
SUP --> MUS
SUP --> INV
MUS --> T1 --> DB
INV --> T2 --> DB
DB --> T1 --> MUS
DB --> T2 --> INV
MUS --> SUP
INV --> SUP
SUP --> CM
CM --> STORE
SUP --> R
R --> UI2
S -. persisted per turn .- CKPT
```
**Invariants:**
- Only `verify_info` writes `customer_id`. No sub-agent or tool mutates it.
- Only tools touch `DB`. Neither the supervisor nor the verifier executes SQL directly (except the targeted lookups in `verify_info`).
- `create_memory` only **unions** into `InMemoryStore`; deletions are not possible via this path.
---
## Technology Stack
| Layer | Technology | Version | Role |
|---|---|---|---|
| Language | Python | 3.12+ | Runtime |
| UI | Gradio | 5.29+ | Chat interface, streaming, interrupts |
| Agent Orchestration | LangGraph | 1.0+ | State machine, checkpointing, ToolNode |
| Supervisor | langgraph-supervisor | 0.0.20+ | Hierarchical routing |
| Prebuilt Agents | langgraph-prebuilt | 1.0+ | `create_react_agent`, `ToolNode` |
| LLM Integration | langchain-openai | 1.0+ | `ChatOpenAI` (any OpenAI-compatible API) |
| Core Framework | langchain + langchain-core + langchain-community | 1.0+ / 0.4+ | Messages, tools, SQLDatabase utility |
| Data Validation | Pydantic | v2+ | `UserInput`, `UserProfile` schemas |
| Database Engine | SQLAlchemy | 2.0+ | In-memory SQLite via `StaticPool` |
| Dataset | Chinook | - | Customers, invoices, tracks, albums, artists |
| Checkpointer | `langgraph.checkpoint.memory.MemorySaver` | - | Per-thread short-term state |
| Store | `langgraph.store.memory.InMemoryStore` | - | Per-customer long-term memory |
| Env Config | python-dotenv | 1.0+ | Loads `.env` |
| HTTP | requests | 2.31+ | One-shot SQL script fetch |
| Packaging | Docker | 3.12-slim | Reproducible deploy |
| Hosting | Hugging Face Spaces | - | YAML-frontmatter driven |
---
## Project Structure
```
Multi-Agent-Customer-Support/
βββ app.py # Entry point (local + HF Spaces: module-level app for HF import)
βββ Dockerfile # Python 3.12-slim, exposes :7860, runs app.py
βββ requirements.txt # Pinned min versions
βββ .env.example # OPENAI_API_KEY, MODEL_NAME, TEMPERATURE, PORT
βββ Chinook_Sqlite.sql # Cached dataset (auto-downloaded if missing)
β
βββ src/
β βββ config.py # Settings class; reads env, sets logging format
β βββ state.py # LangGraph State TypedDict
β βββ models.py # Pydantic schemas: UserInput, UserProfile
β β
β βββ db/
β β βββ database.py # SQLAlchemy engine, run_query_safe, normalize_phone, verify_database
β β
β βββ tools/
β β βββ music_catalog.py # 5 @tool functions (fuzzy SQL, deterministic sampling)
β β βββ invoice.py # 4 @tool functions (customer-scoped queries)
β β
β βββ agents/
β β βββ prompts.py # All system prompts (supervisor, sub-agents, verification, memory)
β β βββ nodes.py # Graph node functions: verify_info, human_input, load_memory, create_memory, music_assistant, should_continue, should_interrupt
β β βββ graph.py # build_graph(): assembles music subgraph, invoice ReAct, supervisor, outer graph
β β
β βββ ui/
β βββ app.py # Gradio Blocks, stream handler, status bar, reset button
β βββ styles.py # CUSTOM_CSS
β
βββ tests/
βββ conftest.py # DB fixture (session-scoped)
βββ test_database.py # 11 tests: run_query_safe, normalize_phone, verify_database
βββ test_tools.py # 17 tests: all 9 tool functions
```
**Key files to read in order when grokking the repo:**
1. `src/state.py` - the shared contract.
2. `src/agents/graph.py` - how the whole thing is wired.
3. `src/agents/nodes.py` - what each node does.
4. `src/agents/prompts.py` - the behavioral contract for every LLM call.
5. `src/tools/*.py` - the data surface.
6. `src/ui/app.py` - how streaming + interrupts are surfaced.
---
## Application Flow (Gradio UI)
```mermaid
sequenceDiagram
participant User
participant Gradio
participant Graph as LangGraph
participant Sub as Sub-Agent
participant SQL as SQLite
User->>Gradio: type message + Enter
Gradio->>Gradio: show_user_message (optimistic render)
Gradio->>Graph: graph.stream(input, thread_id)
Graph->>Graph: verify_info
alt customer not verified
Graph-->>Gradio: interrupt (snapshot.next set)
Gradio->>User: "Waiting for your input"
User->>Gradio: identifier
Gradio->>Graph: resume
end
Graph->>Graph: load_memory
Graph->>Sub: supervisor routes
Sub->>SQL: parameterized query
SQL-->>Sub: rows (JSON)
Sub-->>Graph: AIMessage
Graph->>Graph: create_memory (union preferences)
Graph-->>Gradio: final AIMessage + elapsed
Gradio->>User: assistant reply + status "Responded in N.Ns Β· Data sources: β¦"
```
Every browser session is assigned a UUID `thread_id` stored in `gr.State`. This scopes the checkpointer so concurrent users never see each other's turns. The "New Conversation" button just rotates the UUID.
---
## Pipeline Stages
Each node is a pure function over `State` (plus optional `store`/`config`). Stages in execution order:
### 1. `verify_info` - Identity Gate
- **Input:** `messages`, maybe existing `customer_id`.
- **If already verified:** no-op pass-through.
- **Else:** calls `llm.with_structured_output(UserInput)` to pull one identifier (ID / email / phone). Runs a parameterized SQL lookup:
- numeric β `CustomerId =`
- contains `@` β `LOWER(Email) =`
- else β `normalize_phone()` compared against normalized DB phones.
- **If found:** writes `customer_id` and a `SystemMessage` announcing the verified ID.
- **If not found:** invokes a polite re-prompt LLM using `VERIFICATION_PROMPT`.
### 2. `human_input` - Interrupt
- Calls LangGraph `interrupt("Please provide input.")`. The UI receives this via `snapshot.next` and pauses the turn. When the user replies, the graph resumes and loops back to `verify_info`.
### 3. `load_memory` - Preference Hydration
- Reads `("memory_profile", customer_id)` from `InMemoryStore`.
- Formats as `"Music Preferences: rock, AC/DC, jazz"` and sets `loaded_memory`.
- The music agent's prompt interpolates this string so it can personalize without re-asking.
### 4. `supervisor` - Hierarchical Router
- Built via `langgraph_supervisor.create_supervisor`.
- Routing rules (encoded in `SUPERVISOR_PROMPT`):
- music/catalog β `music_catalog_subagent`
- invoice/purchase/billing β `invoice_information_subagent`
- mixed β invoice first, then music
- off-topic β direct refusal, no sub-agent invoked
- Merges sub-agent outputs into a single coherent response. Never adds information not present in sub-agent outputs.
### 5a. `music_catalog_subagent` - Hand-Built ReAct
- Custom `StateGraph` with two nodes: `music_assistant` (LLM with bound tools) and `music_tool_node` (`ToolNode(music_tools)`).
- Conditional edge `should_continue` loops until there are no `tool_calls` left.
- System prompt is generated per call via `generate_music_assistant_prompt(loaded_memory)` so preferences are fresh.
### 5b. `invoice_information_subagent` - Prebuilt ReAct
- Built via `langgraph.prebuilt.create_react_agent(llm, tools=invoice_tools, prompt=INVOICE_SUBAGENT_PROMPT, state_schema=State)`.
- Prompt explicitly tells it to use the **verified** `customer_id` from the `SystemMessage`, not any ID the user mentions.
### 6. `create_memory` - Preference Capture
- Summarizes last 10 messages.
- `llm.with_structured_output(UserProfile)` extracts **explicit** preferences.
- Unions with existing preferences; if the LLM returns empty but there are existing preferences, the write is **skipped** (never erases).
- Writes back to `InMemoryStore`.
---
## Getting Started
### Prerequisites
- Python **3.12** (Python 3.13 is blocked on HF Spaces because Python 3.13 removes `audioop`).
- An OpenAI API key *or* any OpenAI-compatible endpoint (Groq, Together, Azure OpenAI, LM Studio, Ollamaβ¦).
- Git.
### Quick Start
```bash
# 1. Clone
git clone https://github.com/ANI-IN/Multi-Agent-Customer-Support.git
cd Multi-Agent-Customer-Support
# 2. Virtualenv
python3.12 -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
# 3. Deps
pip install -r requirements.txt
# 4. Config
cp .env.example .env
# edit .env β set OPENAI_API_KEY
# 5. Run
python app.py
# β http://localhost:7860
```
**First-run chat script:**
```
> My customer ID is 5
> What AC/DC albums do you have?
> Show me my most expensive purchase.
> I love rock music. # saved to memory
# ... restart the app, verify again as customer 5 ...
> What genres do you think I'd like?
```
### Sample Dataset
The app boots against the [Chinook sample database](https://github.com/lerocha/chinook-database), loaded into an in-memory SQLite instance via SQLAlchemy `StaticPool`. On first run it reads `Chinook_Sqlite.sql` from the repo root; if missing, it downloads and caches it.
| Table | Rows | Notes |
|---|---:|---|
| Customer | 59 | PII + `SupportRepId` FK to Employee |
| Employee | 8 | Support reps |
| Invoice | 412 | `CustomerId`, `InvoiceDate`, `Total` |
| InvoiceLine | 2,240 | Each row = one purchased track |
| Track | 3,503 | `AlbumId`, `GenreId`, `MediaTypeId`, `UnitPrice` |
| Album | 347 | `ArtistId` FK |
| Artist | 275 | - |
| Genre | 25 | - |
| MediaType | 5 | - |
| Playlist / PlaylistTrack | 18 / 8,715 | Not currently exposed as tools |
### Developer Commands
```bash
# Run app
python app.py
# Full test suite (28 tests)
pytest tests/ -v
# Only DB layer
pytest tests/test_database.py -v
# Only tools
pytest tests/test_tools.py -v
# Docker build + run
docker build -t music-support .
docker run -p 7860:7860 -e OPENAI_API_KEY=sk-... music-support
# Quick sanity check without the UI
python -c "from src.db.database import verify_database; print(verify_database())"
```
---
## Configuration
All configuration is env-driven. `src/config.py` loads `.env` once at import time.
| Variable | Required | Default | Purpose |
|---|---|---|---|
| `OPENAI_API_KEY` | yes | - | API key for the LLM provider |
| `OPENAI_API_BASE` | no | - | Override base URL for non-OpenAI providers |
| `MODEL_NAME` | no | `gpt-4o-mini` | Chat model name |
| `TEMPERATURE` | no | `0` | `0` = fully deterministic routing |
| `PORT` | no | `7860` | Gradio port |
### LLM Provider (Pick One)
The project uses `ChatOpenAI`, which speaks the OpenAI protocol. Any compatible provider works by setting `OPENAI_API_BASE`.
<details>
<summary><b>OpenAI (default)</b></summary>
```env
OPENAI_API_KEY=sk-...
MODEL_NAME=gpt-4o-mini
```
</details>
<details>
<summary><b>Groq</b></summary>
```env
OPENAI_API_BASE=https://api.groq.com/openai/v1
OPENAI_API_KEY=gsk_...
MODEL_NAME=llama-3.3-70b-versatile
```
</details>
<details>
<summary><b>Together AI</b></summary>
```env
OPENAI_API_BASE=https://api.together.xyz/v1
OPENAI_API_KEY=...
MODEL_NAME=meta-llama/Llama-3.3-70B-Instruct-Turbo
```
</details>
<details>
<summary><b>Azure OpenAI</b></summary>
```env
OPENAI_API_BASE=https://your-resource.openai.azure.com/
OPENAI_API_KEY=...
MODEL_NAME=your-deployment-name
```
</details>
<details>
<summary><b>Local (LM Studio / Ollama / vLLM)</b></summary>
```env
OPENAI_API_BASE=http://localhost:1234/v1
OPENAI_API_KEY=not-needed
MODEL_NAME=your-local-model
```
</details>
> **Tip:** The supervisor relies on the model following structured routing instructions. Models smaller than ~7B may degrade routing accuracy on mixed queries.
---
## Tools Reference
### Music Catalog Tools (`src/tools/music_catalog.py`)
| Tool | Signature | Returns |
|---|---|---|
| `get_albums_by_artist` | `(artist: str)` | Album rows, fuzzy `LIKE '%artist%'` |
| `get_tracks_by_artist` | `(artist: str)` | Total count + up to 20 full-detail tracks |
| `get_songs_by_genre` | `(genre: str)` | Total count + 1 track per artist (up to 10), deterministic via `ROW_NUMBER()` CTE |
| `check_for_songs` | `(song_title: str)` | Up to 10 full-detail matches on track name |
| `get_track_details` | `(track_id: str)` | Every column for one track including computed `SizeMB` |
### Invoice Tools (`src/tools/invoice.py`)
| Tool | Signature | Returns |
|---|---|---|
| `get_invoices_by_customer_sorted_by_date` | `(customer_id: str)` | All invoices DESC by date |
| `get_invoice_line_items_sorted_by_price` | `(customer_id: str)` | All purchased **tracks** (not invoices) DESC by unit price |
| `get_employee_by_invoice_and_customer` | `(invoice_id, customer_id)` | Support rep name / title / email |
| `get_invoice_line_items` | `(invoice_id, customer_id)` | Full track details for one invoice |
All tool inputs pass through `_safe_int()` for numeric args. All return values are either JSON-serialized row lists or a human-readable "not found" string. Empty results are never silently collapsed.
---
## Prompt Engineering & Anti-Hallucination
Grounding rules (applied to every sub-agent prompt in `src/agents/prompts.py`):
1. **Tool-only** - never answer from model memory; always call a tool first.
2. **Exact quoting** - no rounding, no estimating, no "about".
3. **Honest failures** - "I could not find that in our catalog." is the literal fallback.
4. **Scope boundaries** - each sub-agent explicitly refuses out-of-scope queries and defers.
5. **Truncation transparency** - when results are sampled (LIMIT), say so and include the total.
6. **No invented IDs** - the invoice agent is told to read the verified `customer_id` from the `SystemMessage`, not from user text.
Memory rules (`CREATE_MEMORY_PROMPT`):
- Only **explicit** statements count ("I love jazz" β
; "Do you have jazz?" β).
- New preferences **merge** with existing (set union).
- If the LLM returns empty but prior preferences exist, **skip the write**.
---
## Security
| Threat | Mitigation |
|---|---|
| SQL injection | Every query uses SQLAlchemy `text(...)` with bound `:name` parameters. No f-strings or concatenation. |
| Cross-customer data leak | `customer_id` is set only by `verify_info` and passed via `SystemMessage`. Invoice tools require it as a typed parameter. |
| Hallucinated accounts | Verification looks up against the real `Customer` table; unknown IDs produce a polite retry prompt, not a pass-through. |
| Numeric crashes | `_safe_int()` wraps every numeric tool arg and returns a friendly error instead of propagating `ValueError`. |
| Phone format bypass | `normalize_phone()` strips non-digits (preserving `+`), so `+1 (555) 123-4567` matches `15551234567`. |
| Thread cross-talk | Gradio issues a UUID `thread_id` per session; the checkpointer is scoped to it. |
---
## Testing
**28 pytest tests**, all deterministic, all hit the real in-memory DB.
```bash
pytest tests/ -v
```
| File | Tests | Coverage |
|---|---:|---|
| `tests/test_database.py` | 11 | `run_query_safe` (happy path, params, empty, JSON shape), `normalize_phone` (intl, domestic, dashes, empty, None, `+` prefix), `verify_database` |
| `tests/test_tools.py` | 17 | All 5 music tools + all 4 invoice tools; found / not-found / invalid-id / determinism / DESC-date ordering |
Notable determinism check:
```python
def test_get_songs_by_genre_deterministic(self):
r1 = get_songs_by_genre.invoke({"genre": "Rock"})
r2 = get_songs_by_genre.invoke({"genre": "Rock"})
assert r1 == r2
```
---
## Deployment
### Hugging Face Spaces
This README's YAML frontmatter is the HF Spaces config. Push the repo to a Gradio Space, set `OPENAI_API_KEY` in **Settings β Repository Secrets**, and HF builds and runs `app.py` automatically. Python is pinned to 3.12 (3.13 breaks `audioop` imports pulled in transitively).
### Docker
```bash
docker build -t music-support .
docker run -d \
-p 7860:7860 \
-e OPENAI_API_KEY=sk-... \
-e MODEL_NAME=gpt-4o-mini \
--name music-support \
--restart unless-stopped \
music-support
```
### Docker Compose
```yaml
services:
music-support:
build: .
ports: ["7860:7860"]
environment:
- OPENAI_API_KEY=${OPENAI_API_KEY}
- MODEL_NAME=gpt-4o-mini
- TEMPERATURE=0
restart: unless-stopped
```
---
## Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| `ModuleNotFoundError: gradio` | Deps not installed | `pip install -r requirements.txt` |
| `ModuleNotFoundError: audioop` | Python 3.13 | Use Python 3.12 |
| `ImportError: HfFolder` | Old Gradio | `gradio>=5.29.0` |
| `TypeError: argument of type 'bool' is not iterable` | Gradio/client schema bug | `gradio>=5.29.0` |
| `OPENAI_API_KEY not set` | Missing `.env` | `cp .env.example .env` + edit |
| Downloads Chinook on every start | Cache file missing | First run caches it; subsequent runs read locally |
| Verification keeps failing | No matching customer | Try Customer ID `5` (known to exist); or a real Chinook email / phone |
---
## Roadmap
- Persistent storage: swap `MemorySaver` β `SqliteSaver`; swap `InMemoryStore` β Postgres- or Redis-backed store.
- Token streaming in the UI (currently streams at node-event granularity).
- Playlist and customer-profile tools (tables present, tools not yet exposed).
- Structured JSON logs with correlation IDs per `thread_id` + latency metrics.
- CI pipeline (GitHub Actions) running `pytest` on every PR.
- Per-session rate limiting at the UI boundary.
---
## License
MIT. See [LICENSE](LICENSE).
---
<div align="center">
<sub>Built and maintained by <b>Animesh Kumar</b> Β· LangGraph Β· Gradio Β· Chinook</sub>
</div>
|