Skip to content

Release v1.0.0

Latest
Latest

Choose a tag to compare

View all tags
@GabrielEValenzuela GabrielEValenzuela released this 16 Feb 17:36
· 4 commits to master since this release
v1.0.0
56fd038
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release Notes - Version 1.0.0

Release Date: February 2025

Important

The summary of the project is available on Project description #1
Please check that issue to understand the scope and decisions of the project fully.

Overview

This marks the first stable release (1.0.0) of the ChatML API, a FastAPI-based microservice designed for knowledge graph similarity detection. This release introduces core functionalities, logging, structured routing, database integration, and a containerized environment using Docker and Traefik.

🆕 What's New

Core Features

  • API Logging: Implemented a structured logging mechanism to capture API operations and enhance observability. (#20)
  • Home Route: Provides API metadata, including version, author, dependencies, and available endpoints. (#22)
  • User Authentication:
    • Register: Allows users to create accounts and generate API keys. (#24)
    • Login: Implements JWT-based authentication for secure access.
  • Similarity Detection Service: Exposes an endpoint that leverages PyKeen to detect similarities between knowledge graph entities. (#25)
  • Database Integration:
    • PostgreSQL: Stores API keys and enforces access control. (#26)
    • MongoDB: Handles user authentication data.
  • PyKeen Implementation: Loads a pre-trained TransH model to perform similarity inference. (#30)
  • Containerized Deployment: Dockerized the entire application, ensuring a reproducible and scalable deployment process. (#32)

🔧 Fixes & Improvements

Bug Fixes

  • Fixed Empty Password Registration: Prevents users from registering with an empty password. (#40)
  • Fixed PostgreSQL Permissions: Resolved database privilege issues preventing API key storage. (#41)

Enhancements & Refactors

  • Traefik Integration: Replaced Nginx with Traefik as the reverse proxy, improving service discovery and SSL management. (#42)
  • Dockerfile Optimization: Improved image efficiency and reduced build time.
  • Updated README: Clarified setup instructions and refined documentation. (#43)
  • Added CHANGELOG: Introduced a structured changelog following Keep a Changelog and Semantic Versioning. (#44)

🔥 Breaking Changes

  • Replaced Nginx with Traefik: All previous Nginx configurations are deprecated. Users must now configure routes using Traefik labels in docker-compose.yml.
  • New Authentication System: API keys are now stored in PostgreSQL, and user authentication uses JWT.

🎯 Next Steps

  • Add unit and integration tests for key API operations.
  • Improve caching strategy using Redis for API responses.

🚀 ChatML API is now ready for production usage! Thanks to all contributors!

🔥🚀 Check the demo video below!

demo_video.mp4
Assets 2
Loading