Search design doc

[tekrajchhetri]

Addressed: #76

This design document provides a high-level architectural overview and design considerations (algorithms + system implementation) for search for StructSense + Dandi.

[gemini-code-assist]

Summary of Changes

Hello @tekrajchhetri, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a foundational design document for a new search system tailored for StructSense and Dandi. The initiative aims to mitigate current dependencies on BioPortal by establishing an independent, high-performance search capability. The proposed architecture details a hybrid retrieval and reranking strategy, integrating advanced techniques like vector search and various encoder models, all encapsulated within a modular, API-first service designed for scalability and extensibility.

Highlights

• New Search Design Document: A comprehensive design document for a new search system for StructSense + Dandi has been added, outlining its architecture and design considerations.
• Addressing BioPortal Limitations: The document identifies and addresses current limitations stemming from the dependency on BioPortal, such as API rate limits and implementation reliance.
• Hybrid Retrieval and Reranking Approach: A two-stage search process is proposed, combining efficient retrieval (e.g., BM25, vector search) with advanced reranking techniques (e.g., dual-encoders, cross-encoders) to optimize relevance and performance.
• Key Search Requirements: The design emphasizes support for contextualized retrieval, keyword-based search, and generalizability to various use cases.
• API-First Implementation with Design Principles: The system will be implemented as an API-first service with modular components, adhering to principles like scalability, extensibility, and provenance by design.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• docs/design_docs/search_design_doc.md
  • Added a new design document for the search system.

Activity

• No specific activity (comments, reviews, etc.) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a comprehensive design document for a new search system. The document is well-structured, outlining the motivation, requirements, and a solid two-stage (retrieval and re-ranking) architectural approach. My review includes a few suggestions to fix minor typos, an invalid tag in the Mermaid diagram, and placeholder content in the references to enhance the document's accuracy and clarity.

[gemini-code-assist]

There's an invalid closing tag </br> in the mermaid diagram definition. The correct tag for a line break is <br>. For consistency, you might want to use the same style for all line breaks in the diagram.

Suggested change

	G -- </br> --> H2
	G -- <br> --> H2