ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Kaapi platform API Versioning
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 18
- 派生
- 10
- 平均合并
- 2 天 20 小时
- 30 天内合并 PR
- 14
描述
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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先梳理 collection 模块当前的 API 及其与 Dalgo 的集成,重点关注 issue 中描述的 OpenAI assistant 和 vector-store 行为。明确 v1 必须保留的内容、移至 v2 的内容,以及版本方案和文档将如何表明 v1 仍保持兼容,同时 v2 移除 assistant 创建功能。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- api, backend
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100