-
Notifications
You must be signed in to change notification settings - Fork 189
Open
Description
The src/core/embeddings.py module provides vector embeddings and database functionality using LangChain and Chroma. While the code has basic logging and exception handling, the following areas could be improved:
-
Documentation:
- Docstrings for methods, especially for parameters and return values.
- Usage examples for the VectorStore class.
- Clarify expected input types, e.g.,
documents: List.
-
Error Handling:
- Add more informative error messages.
- Consider custom exception classes for database operations.
-
Type Annotations:
- Specify types for
documentsparameter (e.g.,List[Document]) if possible.
- Specify types for
-
Testing:
- Unit tests for
create_vector_dbanddelete_collectionmethods. - Test for edge cases (empty documents, invalid model name, etc.).
- Unit tests for
Please provide the following details to help refine this issue:
- Are there specific use cases or bugs you've encountered?
- Should the issue target documentation, code improvements, or both?
- Any preferred format or style for docstrings and error messages?
- Do you have examples of typical
documentsinput? - Should this include writing new tests, or just improvements to current code?
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels