docs: add ADR for AI chat history storage#135
Conversation
|
Thanks for the pull request, @MaferMazu! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #135 +/- ##
==========================================
+ Coverage 91.22% 94.34% +3.11%
==========================================
Files 51 60 +9
Lines 4547 6858 +2311
Branches 276 370 +94
==========================================
+ Hits 4148 6470 +2322
+ Misses 311 296 -15
- Partials 88 92 +4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@ormsbee @feanil @kdmccormick I would like your review of this ADR ✨ |
feanil
left a comment
There was a problem hiding this comment.
I'm a little concerned that submissions might be a leaky abstraction for this use-case but I want to understand better what you're thinking for the mapping from AI Chats to submission items. If for example each turn is a separate submission, then retrieval might be more expensive than what we've done historically here since instead of 5-10 attempt items retrieved it might be hundreds of chat messages/response pairs.
|
Hey @feanil thanks a lot. Your concern about this being a leaky abstraction is valid. Up to now it has worked because it gives us an existing persistence layer, security model, and APIs without introducing a new storage system, but it does come with tradeoffs. I updated the ADR to make that explicit. I explain how we are using it and what the limit of 100KB means in practice with some rough estimates. Some optimizations will need to be future work, but being clear about what they are is a good first step here. |
felipemontoya
left a comment
There was a problem hiding this comment.
Thanks a lot @feanil @ormsbee @Henrrypg. Your comments and contributions made this idea better, but also the code as we were able to update it to use submissions in a better way. From my side I think this ADR is accepted and we should merge it and continue, but I'll wait to hear from you in case you have any other open comment.
|
It's always exciting to see the stuff you folks are building here. Thank you for being so receptive to feedback! |
Henrrypg
left a comment
There was a problem hiding this comment.
Thanks for the update @felipemontoya. I'm agree with whole ADR. Thanks @MaferMazu
Description
This PR adds the ADR: Use Open edX Submission Service for Persistent Chat History in the AI extensions framework.
How to test
You can read it here: https://github.com/eduNEXT/openedx-ai-extensions/blob/fbfac9d4ddc706d63098b0b6dbb349bf88aa334b/docs/decisions/0004-submission-as-chat-storage.rst