# azure-samples/netai-chat-with-your-data architecture

> Architecture diagram of the GitHub repository azure-samples/netai-chat-with-your-data, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/azure-samples/netai-chat-with-your-data
- Repository: https://github.com/azure-samples/netai-chat-with-your-data

## Overview

##### Main Components
- Frontend/UIs:
- Chat Application (located in src/ChatWYData.ChatApp) – built with Razor components; it provides the user chat interface.
- Document Manager Application (located in src/ChatWYData.DocsMngr) – for managing uploads, updates, and document browsing.
- Backend/API Services:
- ChatWYData.ApiServices, ChatWYData.DescriptionApi, ChatWYData.DocumentsApi, ChatWYData.MarkDown APIs, and VectorStore API – these provide endpoints for chat operations, document processing, Markdown handling, and vector search functionalities.
- Infrastructure/Provisioning:
- The “infra” directories (both at the root and under the AppHost) contain Bicep modules and YAML templates to provision Azure resources such as:
- Azure AI Search (azureaisearch module)
- Azure OpenAI (openai module)
- Azure Application Insights (appInsights module)
- Storage and SQL resources
- The AppHost (ChatWYData.AppHost) also ties resource configuration, local dev credentials, and orchestrates the provisioning (via Azure Developer CLI and .NET Aspire integration).
- Data Access and Entities:
- Projects like ChatWYData.DataEntities, ChatWYData.FileEntities, SearchEntities, and VectorEntities that define the data models and services for persistence and vector storage.

##### Relationships and Interactions
- End-User Interaction:
- Users input chat queries and document uploads via the UI components. These interfaces send requests to the corresponding backend API layer.
- API Gateway and Business Logic:
- The various API projects (DescriptionApi, DocumentsApi, MarkDown APIs, etc.) process requests and use domain-specific logic (for example, extracting document contents, converting Markdown, or managing chat sessions).
- Integration with Azure Services:
- API services leverage Azure AI Search to perform semantic searches and retrieval of document information.
- Azure OpenAI services (using models like gpt-4o and text-embedding-ada-002) process natural language queries and generate responses.
- Telemetry and monitoring are provided via Azure Application Insights and the .NET Aspire Dashboard.
- Infrastructure Provisioning:
- The infrastructure folder’s Bicep templates deploy the necessary Azure resources used by the solution (e.g., storage, search, openai endpoints).
- DevOps related files (azure.yaml, deployment scripts) are used for provisioning and deployment in GitHub Codespaces or locally.

##### Architectural Patterns & Technologies
- Full-stack separation: Clearly split the frontend (Blazor WebAssembly/Razor components) from backend services.
- API/Microservices pattern: Multiple API projects handle specialized functions.
- Infrastructure-as-Code: Bicep modules and YAML templates define cloud resource deployments.
- Cloud-Native Integration: Tight integration with Azure AI Search, Azure OpenAI, and Application Insights.
- .NET Aspire Integration: Provides telemetry, cloud provisioning, and monitoring capabilities.
- Data & Document Processing: Use of vector databases and semantic search to match user queries with document content.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Presentation Layer"
        ChatApp["Chat Application (ChatWYData.ChatApp)"]:::frontend
        DocsMngr["Document Manager (ChatWYData.DocsMngr)"]:::frontend
    end

    subgraph "API Layer"
        ChatApi["Chat API Services (ChatWYData.ApiServices)"]:::api
        DescApi["Description API (ChatWYData.DescriptionApi)"]:::api
        DocsApi["Documents API (ChatWYData.DocumentsApi)"]:::api
        MD_Bash["MarkDown APIs - Bash (ChatWYData.MarkDown.MarkitdownBashApi)"]:::api
        MD_CS["MarkDown APIs - CSnakes (ChatWYData.MarkDown.MarkitdownCSnakes)"]:::api
        MD_Api["MarkDown API (ChatWYData.MarkDownApi)"]:::api
        VecApi["VectorStore API (ChatWYData.VectorStoreAzureAISearch)"]:::api
    end

    subgraph "Data Access Layer"
        DataEnt["Data Entities (ChatWYData.DataEntities)"]:::data
        FileEnt["File Entities (ChatWYData.FileEntities)"]:::data
        SearchEnt["Search Entities (ChatWYData.SearchEntities)"]:::data
        VecEnt["Vector Entities (ChatWYData.VectorEntities)"]:::data
    end

    subgraph "Infrastructure Layer"
        AzureSearch["Azure AI Search"]:::infra
        AzureOpenAI["Azure OpenAI"]:::infra
        Storage["Storage Service"]:::infra
        AppInsights["Application Insights"]:::infra
        InfraProv["Infrastructure Provisioning (infra)"]:::infra
        AppHost["AppHost Provisioning (ChatWYData.AppHost)"]:::infra
    end

    %% Connections between UI and API Layer
    ChatApp -->|"HTTPRequest"| ChatApi
    ChatApp -->|"HTTPRequest"| DescApi
    DocsMngr -->|"Upload/manage"| DocsApi

    %% API to Azure OpenAI for query and processing
    ChatApi -->|"NLPprocessing"| AzureOpenAI
    DescApi -->|"NLPprocessing"| AzureOpenAI
    DocsApi -->|"NLPprocessing"| AzureOpenAI

    %% VectorStore API uses Azure AI Search for semantic queries
    VecApi -->|"VectorQuery"| AzureSearch

    %% APIs send telemetry to Application Insights
    ChatApi -->|"Telemetry"| AppInsights
    DescApi -->|"Telemetry"| AppInsights
    DocsApi -->|"Telemetry"| AppInsights
    MD_Bash -->|"Telemetry"| AppInsights
    MD_CS -->|"Telemetry"| AppInsights
    MD_Api -->|"Telemetry"| AppInsights
    VecApi -->|"Telemetry"| AppInsights

    %% APIs interact with Data Access Layer
    ChatApi -->|"DataOps"| DataEnt
    DocsApi -->|"DataOps"| FileEnt
    DocsApi -->|"DataOps"| SearchEnt
    VecApi -->|"DataOps"| VecEnt

    %% Infrastructure Provisioning interactions
    AppHost -->|"Deploys"| AzureSearch
    AppHost -->|"Deploys"| AzureOpenAI
    AppHost -->|"Deploys"| Storage
    AppHost -->|"Deploys"| AppInsights

    InfraProv -->|"Defines"| AzureSearch
    InfraProv -->|"Defines"| AzureOpenAI
    InfraProv -->|"Defines"| Storage
    InfraProv -->|"Defines"| AppInsights

    %% Styles
    classDef frontend fill:#AEDFF7,stroke:#000,stroke-width:1px;
    classDef api fill:#C8E6C9,stroke:#000,stroke-width:1px;
    classDef data fill:#FFCC80,stroke:#000,stroke-width:1px;
    classDef infra fill:#D1C4E9,stroke:#000,stroke-width:1px;

    %% Click Events
    click ChatApp "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.ChatApp"
    click DocsMngr "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.DocsMngr"
    click ChatApi "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.ApiServices"
    click DescApi "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.DescriptionApi"
    click DocsApi "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.DocumentsApi"
    click MD_Bash "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.MarkDown.MarkitdownBashApi"
    click MD_CS "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.MarkDown.MarkitdownCSnakes"
    click MD_Api "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.MarkDownApi"
    click VecApi "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.VectorStoreAzureAISearch"
    click InfraProv "https://github.com/azure-samples/netai-chat-with-your-data/tree/main/infra"
    click AppHost "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.AppHost"
    click DataEnt "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.DataEntities"
    click FileEnt "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.FileEntities"
    click SearchEnt "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.SearchEntities"
    click VecEnt "https://github.com/azure-samples/netai-chat-with-your-data/blob/main/src/ChatWYData.VectorEntities"
```
