# pinecone-io/pinecone-vercel-starter architecture

> Architecture diagram of the GitHub repository pinecone-io/pinecone-vercel-starter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pinecone-io/pinecone-vercel-starter
- Repository: https://github.com/pinecone-io/pinecone-vercel-starter

## Overview

##### Frontend Layer Components
- Chat Component (src/app/components/Chat)
- Context Panel Component (src/app/components/Context)
- Header Component

##### API Layer Components
- Chat API (/api/chat)
- Context API (/api/context)
- Crawl API (/api/crawl)
- Clear Index API (/api/clearIndex)
- Crawler Service as a separate component connected to the Crawl API
- Embedding service as a middleware component

##### Infrastructure Layer Components
- Pinecone Vector Database
- OpenAI API
- Data stores:
- Vector Embeddings Store (in Pinecone)
- Document Chunks Store

- User Input → Chat Component → Chat API → OpenAI API
- Crawler → URLs → Document Chunks → Embeddings → Pinecone
- Context API → Pinecone → Context Panel
- User interactions (e.g., blue)
- Data processing flows (e.g., green)
- Storage operations (e.g., orange)

##### Key Processes to Highlight
- RAG Pipeline:
- Document Ingestion
- Embedding Generation
- Vector Storage
- Context Retrieval
- Response Generation

##### Additional Elements
- Environment variables section
- Edge runtime indicators
- Streaming response paths

##### Technical Details
- Next.js 13+ App Router architecture
- Edge Runtime capabilities
- Vercel AI SDK integration
- Document splitting strategies (Recursive/Markdown)

##### Architectural Patterns
- RAG pattern implementation
- Streaming response pattern
- Separation of concerns between crawling, embedding, and chat

##### The edge computing capabilities

This will provide a clear visualization of how the application processes user queries through the RAG system while maintaining context and delivering streaming responses.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Frontend
        NC[Next.js Client]
        CH[Chat Component]:::component
        CP[Context Panel]:::component
        HD[Header]:::component
        NC --> CH
        NC --> CP
        NC --> HD
    end

    subgraph API
        direction TB
        API[Next.js API Routes]
        CHAT["/api/chat"]:::api
        CONT["/api/context"]:::api
        CRAW["/api/crawl"]:::api
        CLR["/api/clearIndex"]:::api
        API --> CHAT
        API --> CONT
        API --> CRAW
        API --> CLR
        
        CRWS[Crawler Service]:::service
        EMBS[Embedding Service]:::service
        CRAW --> CRWS
        CRWS --> EMBS
    end

    subgraph Infrastructure
        direction TB
        PINE[(Pinecone DB)]:::database
        OPEN[OpenAI API]:::external
        VECS[(Vector Store)]:::database
        DOCS[(Document Store)]:::database
    end

    %% Data Flows
    CH --> CHAT
    CHAT --> OPEN
    OPEN --> CH
    CP --> CONT
    CONT --> PINE
    PINE --> CP
    CRWS --> DOCS
    DOCS --> EMBS
    EMBS --> VECS
    VECS --> PINE

    %% RAG Pipeline
    DOCS -- Document Ingestion --> EMBS
    EMBS -- Vector Generation --> VECS
    VECS -- Context Storage --> PINE
    PINE -- Context Retrieval --> OPEN
    OPEN -- Response Generation --> CH

    %% Styles
    classDef component fill:#a8d5ff
    classDef api fill:#ffb3b3
    classDef service fill:#b3ffb3
    classDef database fill:#ffdb99
    classDef external fill:#e6e6e6

    %% Click Events
    click CH "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/components/Chat/index.tsx"
    click CP "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/components/Context/index.tsx"
    click HD "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/components/Header.tsx"
    click CHAT "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/api/chat/route.ts"
    click CONT "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/api/context/route.ts"
    click CRAW "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/api/crawl/route.ts"
    click CLR "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/api/clearIndex/route.ts"
    click CRWS "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/api/crawl/crawler.ts"
    click EMBS "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/utils/embeddings.ts"
    click PINE "https://github.com/pinecone-io/pinecone-vercel-starter/blob/main/src/app/utils/pinecone.ts"
```
