Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add BM25 and Hybrid Search Retrievers to Azure AI Search Integration #1175

Merged
merged 16 commits into from
Nov 20, 2024

Conversation

ttmenezes
Copy link
Contributor

@ttmenezes ttmenezes commented Nov 11, 2024

Related Issues

Proposed Changes:

This PR includes the following features:

  • Implement a BM25 retriever for Azure AI Search
  • Implement a hybrid search retriever for Azure AI Search

How did you test it?

  • Manual testing in Haystack pipelines
  • Added unit tests, using existing pattern from embedding retriever tests

Notes for the reviewer

Used the existing embedding retriever code as a template and primarily just changed the parameters in the calls to the Azure AI Search Python SDK.

Checklist

@CLAassistant
Copy link

CLAassistant commented Nov 11, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type:documentation Improvements or additions to documentation label Nov 11, 2024
@ttmenezes ttmenezes changed the title new azure retrievers Add BM25 and Hybrid Search to Azure AI Search Integration Nov 11, 2024
@ttmenezes ttmenezes changed the title Add BM25 and Hybrid Search to Azure AI Search Integration Add BM25 and Hybrid Search Retrievers to Azure AI Search Integration Nov 11, 2024
@ttmenezes ttmenezes marked this pull request as ready for review November 13, 2024 20:02
@ttmenezes ttmenezes requested a review from a team as a code owner November 13, 2024 20:02
@ttmenezes ttmenezes requested review from vblagoje and removed request for a team November 13, 2024 20:02
@Amnah199 Amnah199 self-requested a review November 15, 2024 11:27
Copy link
Contributor

@Amnah199 Amnah199 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can merge this with one more approval.

Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quite good to me already. I have a couple of very small change requests. Another suggestion for improvement would be to cover the run method with a unit test and mock for example _bm25_retrieval. The test could check that _bm25_retrieval is called with the expected parameters. Similarly for the hybrid retriever.

@julian-risch julian-risch removed the request for review from vblagoje November 19, 2024 15:30
Copy link
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 👍
Edit: I talked to @Amnah199 offline about adding unit tests for the run methods.

@julian-risch julian-risch changed the title Add BM25 and Hybrid Search Retrievers to Azure AI Search Integration feat: Add BM25 and Hybrid Search Retrievers to Azure AI Search Integration Nov 19, 2024
@Amnah199 Amnah199 merged commit 472ada8 into deepset-ai:main Nov 20, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integration for Azure AI Search
4 participants