feat: Added custom document metadata support#2766
Open
StoreksFeed wants to merge 12 commits into
Open
Conversation
Contributor
Author
|
Some of the unit tests seem to be failing due to some recent changes in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds custom document metadata support across backend, API and WebUI. Users can now attach arbitrary key-value metadata to documents during insertion, update them and retrieve documents with metadata during queries.
Related Issues
None
Changes Made
Backend (
lightrag/)base.py: Addedinclude_metadatafield toQueryParamclasslightrag.py:ainsert()to accept and processmetadataparameteraquery()to support metadata viaQueryParamoperate.py: Integrated metadata into document chunking and storageutils.py: Added metadata serialization/deserialization utilities and validation helpersAPI (
lightrag/api/routers/)document_routes.py:/documents/textand/documents/fileendpoints to accept metadata/documents/{document_id}/metadataendpoint for updating metadata via PATCH methodquery_routes.py:/queryendpoint viainclude_metadataflagWebUI (
lightrag_webui/)api/lightrag.ts: Added TypeScript API client methods for metadata operationscomponents/documents/MetadataEditorDialog.tsx: New component for editing document metadatafeatures/DocumentManager.tsx: Integrated metadata editor dialog into document management UIlocales/en.json: Added strings for metadata featuresChecklist
Additional Notes
Implementation:
is_duplicate,original_doc_id,original_track_id,processing_start_time,processing_end_time)Testing:
/documents/textendpoint) and metadata update operations have been testedDocumentation: