Skip to content

InstantMeilisearch: Enable hybrid search #1285

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Feb 7, 2024
Merged

InstantMeilisearch: Enable hybrid search #1285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffbd2b5
Add hybrid object as an overridable search parameter
Feb 5, 2024
b1343c1
Add changeset
Feb 6, 2024
d980bed
Update docs
Feb 6, 2024
98a61f6
Add tests for 'hybrid' in search params
Feb 7, 2024
a2f3192
Update test name
Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fluffy-waves-love.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@meilisearch/instant-meilisearch": minor
---

Enable experimental hybrid search
3 changes: 2 additions & 1 deletion packages/instant-meilisearch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,8 @@ The following options can be overridden:
[`showMatchesPosition`](https://www.meilisearch.com/docs/reference/api/search#show-matches-position),
[`matchingStrategy`](https://www.meilisearch.com/docs/reference/api/search#matching-strategy),
[`showRankingScore`](https://www.meilisearch.com/docs/reference/api/search#ranking-score),
[`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search#customize-attributes-to-search-on-at-search-time).
[`attributesToSearchOn`](https://www.meilisearch.com/docs/reference/api/search#customize-attributes-to-search-on-at-search-time),
[`hybrid`](https://www.meilisearch.com/docs/learn/experimental/vector_search)

```js
instantMeiliSearch(
Expand Down
16 changes: 16 additions & 0 deletions ...es/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@ describe('Parameters adapter', () => {
meiliSearchParams.matchingStrategy
)
})

test('hybrid search configuration can be set via search parameters', () => {
const hybridSearchConfig = {
semanticRatio: 0,
embedder: 'default',
}

const searchParams = adaptSearchParams({
...DEFAULT_CONTEXT,
meiliSearchParams: {
hybrid: hybridSearchConfig,
},
})

expect(searchParams.hybrid).toBe(hybridSearchConfig)
})
})

describe('Geo filter adapter', () => {
Expand Down
7 changes: 7 additions & 0 deletions packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,12 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
meiliSearchParams.attributesToSearchOn = value
}
},
addHybridSearch() {
Copy link
Member

@brunoocasali brunoocasali Feb 6, 2024

Choose a reason for hiding this comment

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

Can you add a test case for that?

Copy link
Collaborator Author

@Strift Strift Feb 7, 2024

Choose a reason for hiding this comment

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

I added a test! It seems to work, but maybe there's a different way to approach this. Let me know!

const value = overrideParams?.hybrid
if (value !== undefined) {
meiliSearchParams.hybrid = value
}
},
}
}

Expand Down Expand Up @@ -263,6 +269,7 @@ export function adaptSearchParams(
meilisearchParams.addMatchingStrategy()
meilisearchParams.addShowRankingScore()
meilisearchParams.addAttributesToSearchOn()
meilisearchParams.addHybridSearch()

return meilisearchParams.getParams()
}
2 changes: 2 additions & 0 deletions packages/instant-meilisearch/src/client/instant-meilisearch-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,11 @@ export function instantMeiliSearch(
const instantMeilisearchConfig = getInstantMeilisearchConfig(
instantMeiliSearchOptions
)

return {
setMeiliSearchParams: (params): void => {
const { meiliSearchParams } = instantMeiliSearchOptions

instantMeiliSearchOptions.meiliSearchParams =
meiliSearchParams === undefined
? params
Expand Down
1 change: 1 addition & 0 deletions packages/instant-meilisearch/src/types/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export type OverridableMeiliSearchSearchParameters = Pick<
| 'matchingStrategy'
| 'showRankingScore'
| 'attributesToSearchOn'
| 'hybrid'
>

type BaseInstantMeiliSearchOptions = {
Expand Down