Add type hints and docstrings to VectorStoreBase and EmbeddingBase#4629
Open
GopalGB wants to merge 1 commit intomem0ai:mainfrom
Open
Add type hints and docstrings to VectorStoreBase and EmbeddingBase#4629GopalGB wants to merge 1 commit intomem0ai:mainfrom
GopalGB wants to merge 1 commit intomem0ai:mainfrom
Conversation
- Add comprehensive type annotations to all abstract methods in VectorStoreBase
- Add parameter and return type docstrings following Google style
- Add missing default value for memory_action parameter in EmbeddingBase.embed()
- Fix typo in reset() docstring ("delete" -> "deleting")
- Import typing constructs (Any, Dict, List, Optional, Union)
This improves IDE autocompletion, static analysis, and developer
experience when implementing custom vector store backends.
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.
Summary
VectorStoreBasememory_actionparameter inEmbeddingBase.embed()reset()docstring ("delete" -> "deleting")Motivation
The
VectorStoreBaseabstract class had no type hints on any of its method signatures, while concrete implementations (e.g.,Qdrant,Chroma) already use typed parameters. This creates a gap where:mypy,pyright) cannot verify implementations match the contractChanges
mem0/vector_stores/base.py:typingimports (Any,Dict,List,Optional,Union)mem0/embeddings/base.py:-> listtoembed()method= Noneformemory_actionparameter (matching all implementations)Test plan