search

Architecture Diagrams

High-level architecture diagrams for the Web Search module. These diagrams provide an overview of the system's structure, components, and their relationships.

hashtag
Diagrams

  1. block-diagram.md - High-level architecture overview

    • API Layer: REST API and MCP Tools for external interfaces

    • Infrastructure: Authentication and WebSocket Event Emitter for security and real-time communication

    • Web Engine Adapter: WebService and Hybrid Firecrawl Engine for core business logic and web operations

    • External Services: LLM Service for content processing, Firecrawl SaaS and Self-Hosted for web scraping

    • Shows component relationships and data flow between layers

  2. class-diagram.md - Simplified class structure

    • Shows core classes: WebService, SnippetService, KeyPointService, HybridFirecrawl, LLMService

    • Displays essential relationships, inheritance, and dependencies

    • Focuses on main public methods and key interactions

    • Illustrates how services extend LLMService and create response models

hashtag
Usage

These diagrams can be viewed:

  • In any Markdown viewer that supports Mermaid (GitHub, GitLab, etc.)

  • In VS Code with the Mermaid extension

  • Online at https://mermaid.live/

  • In documentation tools like MkDocs, Docusaurus, etc.

hashtag
Updating Diagrams

When updating the codebase, please update the relevant diagrams to reflect architectural changes. The diagrams should be kept in sync with the implementation.

PreviousWeb ModuleNextBlock Diagram: Web Module Architecture

Last updated