Skip to content

generate professional client communication reports by analyzing your email communications with clients

Notifications You must be signed in to change notification settings

ATSiem/client-reports

 
 

Repository files navigation

Client Communication Reports

This application helps you generate professional client communication reports by analyzing your email communications with clients. It combines Next.js, TypeScript, the Vercel AI SDK, Microsoft Graph API, and SQLite to create a powerful AI tool for client communication management.

Features

Client Management

  • Create and manage clients with their domains and email addresses
  • Filter emails by client domains and addresses
  • Organize communications by client for better relationship management

Communication Reports

  • Generate detailed client communication reports using OpenAI GPT-4o
  • Customizable report formats with placeholders
  • Save and reuse report templates
  • AI synthesizes emails into structured reports with key topics, action items, and more
  • Two-tier processing approach for efficient and detailed analysis

Custom Report Templates

  • Create fully customizable report templates
  • Use dynamic placeholders like {summary}, {key_topics}, {action_items}
  • Add your own custom placeholders (e.g., {key_technologies}, {project_status}, {stakeholders})
  • The AI intelligently generates content for any placeholder you define
  • Templates can be linked to specific clients

Getting Started

  1. Clone this repository
  2. Create a .env file based on .env.example with your:
    • OPENAI_API_KEY - Get from OpenAI Platform
    • WEBHOOK_SECRET - Random string for webhook security
    • Microsoft Graph API credentials for authentication
  3. Install dependencies: npm install
  4. Start the development server: npm run dev
  5. Initialize the database: npm run db:migrate
  6. For webhook testing, use npm run dev:webhook with smee.io

Technology Stack

  • Frontend: Next.js, React, TailwindCSS, shadcn/ui
  • Backend: Next.js API Routes
  • Database: SQLite with Drizzle ORM
  • AI: OpenAI GPT-4o via Vercel AI SDK
  • Authentication: Microsoft OAuth via MSAL
  • Email Integration: Microsoft Graph API

How It Works

Email Collection

Emails are fetched from two sources:

  1. Microsoft Graph API - directly fetches emails from your Microsoft account
  2. Webhook endpoint - can be connected to other email services like Gmail using external scripts

The system validates, processes, and stores these emails with AI-generated summaries and labels using a dynamic approach for efficiency.

Email Processing Configuration

The application uses smart, model-aware limits to process emails optimally:

  • Model-based Dynamic Sizing: Automatically adjusts processing based on the AI model's context window
  • Adaptive Content Analysis: Allocates more tokens to important/recent emails and less to older ones
  • Token Budget Optimization: Calculates exact limits based on current model's capabilities

Model Selection and Configuration

  • Model Selection: Control which AI models to use for different tasks:

    • OPENAI_SUMMARY_MODEL: Model for email summarization (default: gpt-3.5-turbo)
    • OPENAI_REPORT_MODEL: Model for generating reports (default: gpt-4o-2024-08-06)
    • OPENAI_EMBEDDING_MODEL: Model for vector embeddings (default: text-embedding-3-small)
  • Dynamic Limits: Enable/disable dynamic calculation:

    • USE_DYNAMIC_MODEL_LIMITS: Set to "true" to use model-aware limits (default: true)
  • Configurable Fallback Limits: Override defaults when needed:

    • EMAIL_FETCH_LIMIT: Maximum emails to fetch (default: 1000)
    • EMAIL_PROCESSING_BATCH_SIZE: Emails to process in background tasks (default: 200)
    • EMAIL_EMBEDDING_BATCH_SIZE: Emails to create embeddings for (default: 200)
    • EMBEDDING_BATCH_SIZE: Batch size for embedding processing (default: 20)

Client Reports

The application analyzes emails related to specific clients and generates comprehensive reports that summarize communications, highlight key topics, identify action items, and more. Reports are fully customizable with templates that support any placeholder fields you define. The processing happens in two stages:

  1. Initial summarization of individual emails
  2. Comprehensive analysis across the full email thread context

Creating Custom Reports

When creating a report, you can:

  1. Select a client to filter relevant emails
  2. Choose a date range for the report
  3. Use an existing template or create your own format
  4. Add custom placeholders for specialized content
  5. Link templates to specific clients for quick report generation

The AI will intelligently fill in all placeholders based on your email content, producing a comprehensive client communication report.

Custom Placeholders

The reporting system supports unlimited custom placeholders. Some examples:

  • {client_name} - Client's name
  • {date_range} - Period covered by the report
  • {summary} - Overall communication summary
  • {key_topics} - Main topics discussed
  • {action_items} - Tasks to be completed
  • {next_steps} - Upcoming actions
  • {key_technologies} - Technologies mentioned in emails
  • {project_status} - Overview of project status
  • {stakeholders} - Key people mentioned
  • {open_questions} - Questions that need answers
  • {decision_summary} - Summary of decisions made

You can add any placeholder that makes sense for your reporting needs, and the AI will generate appropriate content by analyzing your email communications.

License

MIT

About

generate professional client communication reports by analyzing your email communications with clients

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.8%
  • CSS 2.1%
  • JavaScript 0.1%