ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Kaapi platform API Versioning
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 18
- Fork
- 10
- Merge trung bình
- 2 ngày 20 giờ
- Pull request đã merge (30 ngày)
- 14
Mô tả
Right now our API is effectively “latest-only.” That makes iterative changes risky and forces clients to upgrade immediately. We have situations where even though we need to evolve a feature's capabilities then we have to think of it in a way it does not affect our current users, this causes us to be limited with the changes we need to do in any module. To solve for this, we need a versioning strategy to:
-
Establish a clear, documented API versioning scheme
-
Stand up v1 as the first frozen version
-
Enable development of v2 (and beyond) without breaking v1
-
for example collection module creates an openai assistant from documents given to the module , but since assistants is going to be deprecated, we will make changes in the module by removing the assistant part and just keep the creation of vector store. although dalgo needs collection to create assitant that is why we will version the collection module where v1 will be the current version, and v2 will be when we will just be creating a vector store from the documents
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách lập bản đồ API hiện tại của mô-đun collection và tích hợp của nó với Dalgo, tập trung vào hành vi của OpenAI assistant và vector-store được mô tả trong issue. Xác định những gì phải được giữ lại trong v1, những gì chuyển sang v2, cũng như cách lược đồ phiên bản và tài liệu sẽ cho thấy v1 vẫn tương thích trong khi v2 loại bỏ việc tạo assistant.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- api, backend
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100