AFRIKAI Label Service

January 24, 2025 View on GitHub Live Demo

Project Overview

The Label Service is a core microservice within the AfrikAI application, designed to handle labeling tasks with a flexible, extensible architecture. By following the design principles implemented here, the service provides a robust framework for processing and managing prompt-response pairs (PRPs) across various task categories.

Core Functions

Process labeling tasks forwarded by the Task Service via multipart file uploads
Provide endpoints to import and manage prompt-response pairs (PRPs)
Handle labeling submissions, reviews, and task status updates

Security Approach

While the current implementation permits all requests, security is strategically managed:

Authentication and authorization are enforced at the API Gateway
Token validation is routed through the Auth Service in the User Microservice
Future enhancements will include direct service-level access controls

Service Design and Relationships

Endpoint Architecture

Base Route: `/api/labels`

Data Import Controller:

POST /import: Processes file uploads (JSON, CSV, XLS)
GET /prompt-response-pairs: Retrieves prompt-response pairs by various identifiers

Label Controller:

POST /submit: Submits ratings and updates PRP status
POST /review: Allows user reviews of PRPs

Technology Stack

Backend: Spring Boot
Programming Paradigm: Reactive programming with Spring WebFlux
Code Enhancement: Lombok annotations

Service Integrations

Task Service: Forwards and manages task processing
API Gateway: Handles authentication and routing
Auth Service: Performs token authentication

Swagger Documentation

Interactive API documentation available at: http://localhost:8083/swagger-ui.html

Installation Guide

Prerequisites

Java 17 or later
Maven

Setup Steps

Clone the repository:

git clone https://github.com/Nadira3/afrikai_apis.git

Navigate to project directory:
```
cd label-service
```
Build the project:
```
mvn clean install
```
Run the service:
```
mvn spring-boot:run
```
Access Swagger Documentation: Open http://localhost:8083/swagger-ui.html in your browser

Usage Guidelines

Task Import

Utilize /import endpoint for multipart file uploads
Supported formats: JSON, CSV, XLS

Labeling Tasks

Use /submit for rating prompt-response pairs
Employ /review for PRP evaluation

Execution Flow

Label Service Interactions

graph TD
    subgraph "External Systems"
        Client[External Client]
        APIGateway[API Gateway]
        AuthService[Authentication Service]
    end

    subgraph "Label Service Ecosystem"
        LabelService[Label Service]
        subgraph "Controllers"
            DataImportController[Data Import Controller]
            LabelController[Label Controller]
        end
        subgraph "Core Components"
            ServiceLayer[Service Layer]
            ValidationComponent[Validation Component]
            RepositoryLayer[Repository Layer]
        end
        Database[(Database)]
    end

    subgraph "Supporting Services"
        TaskService[Task Service]
    end

    Client -->|Authentication Request| APIGateway
    APIGateway -->|Token Validation| AuthService
    AuthService -->|Validated Token| APIGateway
    APIGateway -->|Authenticated Request| LabelService

    LabelService --> DataImportController
    LabelService --> LabelController

    DataImportController --> ValidationComponent
    LabelController --> ValidationComponent

    ValidationComponent --> ServiceLayer
    ServiceLayer --> RepositoryLayer
    RepositoryLayer --> Database

    ServiceLayer <-->|Task Management| TaskService

Detailed Service Sequence

sequenceDiagram
    participant Client
    participant APIGateway
    participant AuthService
    participant LabelService
    participant TaskService
    participant Database

    Client->>APIGateway: Send Request with Authentication Token
    
    alt Authentication Successful
        APIGateway->>AuthService: Validate Token
        AuthService-->>APIGateway: Token Validated
        
        APIGateway->>LabelService: Route Authenticated Request
        
        alt Import Task
            LabelService->>TaskService: Retrieve Task Details
            TaskService-->>LabelService: Return Task Metadata
            
            LabelService->>ValidationComponent: Validate Import Data
            ValidationComponent-->>LabelService: Validation Result
            
            alt Validation Passed
                LabelService->>Database: Store Prompt-Response Pairs
                Database-->>LabelService: Confirmation of Storage
                
                LabelService->>TaskService: Update Task Status
                TaskService-->>LabelService: Status Update Acknowledged
                
                LabelService-->>APIGateway: Success Response
                APIGateway-->>Client: Import Successful
            else Validation Failed
                LabelService-->>APIGateway: Validation Error
                APIGateway-->>Client: Import Failed
            end
        
        else Label Submission
            LabelService->>ValidationComponent: Validate Label Submission
            ValidationComponent-->>LabelService: Validation Result
            
            alt Submission Valid
                LabelService->>Database: Update Prompt-Response Pair
                Database-->>LabelService: Update Confirmation
                
                LabelService->>TaskService: Notify Task Progress
                TaskService-->>LabelService: Progress Acknowledged
                
                LabelService-->>APIGateway: Success Response
                APIGateway-->>Client: Submission Successful
            else Submission Invalid
                LabelService-->>APIGateway: Submission Error
                APIGateway-->>Client: Submission Failed
            end
        end
    
    else Authentication Failed
        APIGateway-->>Client: Authentication Error
    end

License

ALX Backend Specialization Curriculum License

Future Enhancements

Implement role-based access control
Extend support for additional task categories
Develop direct authorization filters within the service

Contributing

Please read our contribution guidelines before submitting pull requests.

Contact

For questions or support, contact the AfrikAI development team.