Skip to main content

Overview

Welcome to the Dudu Platform - a comprehensive recommendation and evaluation system designed to provide personalized product recommendations with robust analytics and performance tracking.

Platform Architecture​

The Dudu Platform consists of two main services that work together to deliver intelligent recommendations and evaluate their effectiveness:

🎯 Recommend Service​

The Recommendation API provides personalized product recommendations based on customer data, preferences, and behavior patterns.

Key Features:

  • Personalized product recommendations
  • Product catalog management
  • Customer preference analysis
  • Real-time recommendation generation

Core Endpoints:

  • POST /api/recommend/recommend - Generate personalized recommendations
  • POST /api/products/upload - Create and manage products
  • GET /api/products/get - Retrieve product information

📊 Evaluate Service​

The Evaluation API provides comprehensive analytics and performance metrics to measure recommendation effectiveness and system performance.

Key Features:

  • Outcome tracking and analysis
  • Performance metrics and statistics
  • Trend analysis over time
  • Decision comparison and ranking

Core Endpoints:

  • POST /api/outcomes/upload - Log decision outcomes
  • GET /api/outcomes/get - Retrieve outcome records
  • GET /api/stats/* - Various analytics and statistics endpoints

Getting Started​

Prerequisites​

  • Python 3.8+
  • MongoDB instance
  • JWT authentication service
  • Node.js 20.0+ (for documentation)

Quick Setup​

  1. Start the Recommend Service:

    cd /Users/ericngo/Desktop/projects/dudu/recommend
    python server.py

    Available at: http://localhost:5051

  2. Start the Evaluate Service:

    cd /Users/ericngo/Desktop/projects/dudu/evaluate
    python server.py

    Available at: http://localhost:5049

  3. Get Your JWT Token: Use the provided authentication script to obtain a token for API access.

Typical Workflow​

  1. Create Products - Upload your product catalog to the Recommend service
  2. Get Recommendations - Request personalized recommendations for customers
  3. Track Outcomes - Log the results of recommendations in the Evaluate service
  4. Analyze Performance - Use statistics to measure effectiveness and optimize

What You'll Need​

  • MongoDB: For storing products, outcomes, and analytics data
  • JWT Authentication: For securing API endpoints
  • Python Environment: With required dependencies installed
  • API Client: For testing endpoints (curl, Postman, etc.)

Documentation Structure​

This documentation is organized into the following sections:

  • Recommend API - Detailed documentation for the recommendation service
  • Evaluate API - Comprehensive analytics and evaluation documentation

Next Steps​