feat: Add search function and developer guide for implementation - #9
Merged
Conversation
Adding search script and guide for backend developers to develop the script around for searching the file through query.
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.
This pull request introduces a new
searchmodule to the processing package, enabling semantic, keyword, and hybrid search capabilities for user queries. It updates the public API to expose new query-side utilities and provides comprehensive documentation for both indexing and search workflows. The main changes are as follows:Search Functionality and API Expansion:
search.pymodule that provides query-side search utilities, including functions for building search queries (build_query) and generating query embeddings (query_vector). This module supports vector, keyword, and hybrid (reciprocal rank fusion) search modes, returning SQL and parameters ready for database execution.app/processing/__init__.pyto publicly exportbuild_queryandquery_vector, and documented their usage in the module docstring.Documentation Improvements:
__init__.pydocstring to include both indexing (ingestion) and searching (query) workflows, with clear examples and updated module descriptions.BACKEND_INTEGRATION.mdfor a complete setup guide.Module Structure and Public Surface:
searchmodule and clarified the roles of each submodule.__all__in__init__.pyto include the new search utilities, ensuring they are accessible from the package's public API.