# skonda29/chatbot architecture

> Architecture diagram of the GitHub repository skonda29/chatbot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/skonda29/chatbot
- Repository: https://github.com/skonda29/chatbot

## Overview

##### Project type and purpose
- This is a backend engine for an AI-driven mental health chatbot (ReachOut).
- It exposes HTTP endpoints via FastAPI, orchestrates several AI services, performs crisis detection, and logs interactions.

##### File structure
- Top-level files:
- main.py — FastAPI app and routing
- chat_engine.py — wraps Gemini API calls for empathetic chat
- doc_engine.py — LlamaIndex-based document Q&A
- huggingface_engine.py — builds HuggingFace semantic embeddings
- crisis.py — crisis detection logic
- logger.py — custom logging/auditing
- models.py — Pydantic models for requests and responses
- data/ — domain documents (stress_management.txt) for Q&A
- nltk_data/ — tokenizers for text preprocessing
- requirements.txt sets Python dependencies.

##### README for additional insights
- Features: conversational engine, document Q&A, crisis detection, embeddings, logging.
- Tech stack: FastAPI, Gemini API, LlamaIndex, HuggingFace sentence transformers, NLTK.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Client
    Client(["Client"]):::external

    %% API Layer
    subgraph "API Layer"
        Router["FastAPI Router"]:::api
        Models["Pydantic Models"]:::internal
    end

    %% Internal Modules
    Tokenizer["Tokenization Module (NLTK)"]:::internal
    Crisis["Crisis Detection Module"]:::internal
    SafetyHandler["Safety Protocol Handler"]:::internal
    ChatEngine["Chat Engine (Gemini API)"]:::internal
    EmbeddingEngine["Embedding Engine (HuggingFace)"]:::internal
    DocEngine["Document Q&A Engine (LlamaIndex)"]:::internal
    Logger["Logging Module"]:::internal

    %% Data Store
    DataStore[(Document Store)]:::datastore

    %% External Services
    GeminiAPI((Gemini API)):::external
    HFModels((HuggingFace Models)):::external

    %% Request Flow
    Client -->|HTTP Request| Router
    Router --> Models
    Router --> Tokenizer
    Router --> Crisis
    Crisis -->|crisis detected| SafetyHandler
    Crisis -->|no crisis| ContinueFlow{{Continue}}

    ContinueFlow --> ChatEngine
    ContinueFlow --> EmbeddingEngine

    EmbeddingEngine --> HFModels
    EmbeddingEngine --> DocEngine
    DocEngine --> DataStore

    ChatEngine --> GeminiAPI

    %% Logging
    Router --> Logger
    Tokenizer --> Logger
    Crisis --> Logger
    SafetyHandler --> Logger
    ChatEngine --> Logger
    EmbeddingEngine --> Logger
    DocEngine --> Logger

    Logger -->|audit logs| DataStore

    ContinueFlow -->|Response| Router
    Router -->|HTTP Response| Client

    %% Click Events
    click Router "https://github.com/skonda29/chatbot/blob/main/main.py"
    click ChatEngine "https://github.com/skonda29/chatbot/blob/main/chat_engine.py"
    click DocEngine "https://github.com/skonda29/chatbot/blob/main/doc_engine.py"
    click EmbeddingEngine "https://github.com/skonda29/chatbot/blob/main/huggingface_engine.py"
    click Crisis "https://github.com/skonda29/chatbot/blob/main/crisis.py"
    click Logger "https://github.com/skonda29/chatbot/blob/main/logger.py"
    click Tokenizer "https://github.com/skonda29/chatbot/tree/main/nltk_data/tokenizers/punkt/"
    click DataStore "https://github.com/skonda29/chatbot/blob/main/data/stress_management.txt"
    click Models "https://github.com/skonda29/chatbot/blob/main/models.py"
    click Requirements "https://github.com/skonda29/chatbot/blob/main/requirements.txt"

    %% Styles
    classDef api fill:#D6EAF8,stroke:#1B4F72,color:#1B2631;
    classDef internal fill:#AED6F1,stroke:#154360,color:#1B2631;
    classDef datastore fill:#ABEBC6,stroke:#196F3D,color:#0B5345;
    classDef external fill:#F9E79F,stroke:#B9770E,color:#7E5109,stroke-dasharray: 5 5;
    class Router,Models api;
    class Tokenizer,Crisis,SafetyHandler,ChatEngine,EmbeddingEngine,DocEngine,Logger internal;
    class DataStore datastore;
    class Client,GeminiAPI,HFModels external;
```
