Skip to content

feat: Add search function and developer guide for implementation - #9

Merged
RK-NerdyBirdy merged 1 commit into
devfrom
Maneet
Jun 13, 2026
Merged

feat: Add search function and developer guide for implementation#9
RK-NerdyBirdy merged 1 commit into
devfrom
Maneet

Conversation

@RK-NerdyBirdy

Copy link
Copy Markdown
Collaborator

This pull request introduces a new search module 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:

  • Added a new search.py module 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.
  • Updated app/processing/__init__.py to publicly export build_query and query_vector, and documented their usage in the module docstring.

Documentation Improvements:

  • Expanded the __init__.py docstring to include both indexing (ingestion) and searching (query) workflows, with clear examples and updated module descriptions.
  • Added a reference to BACKEND_INTEGRATION.md for a complete setup guide.

Module Structure and Public Surface:

  • Updated the modules list in the documentation to include the new search module and clarified the roles of each submodule.
  • Updated __all__ in __init__.py to include the new search utilities, ensuring they are accessible from the package's public API.

Adding search script and guide for backend developers to develop the script around for searching the file through query.
@RK-NerdyBirdy
RK-NerdyBirdy merged commit d892fc5 into dev Jun 13, 2026
7 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant