Define fields to search on at runtime #251

ManyTheFish · 2023-07-03T08:52:58Z

Summary

Update specifications related to the Define fields to search on at runtime feature.

Changes

Add the new search parameter definition
Add related error messages
Update OpenAPI

github-actions · 2023-07-03T09:41:35Z

🚨 Breaking API change detected:

Modified (3)

[Breaking] DELETE /indexes/{indexUid}/documents/{documentId}
- [Breaking] Header removed: Content-Type
- [Breaking] Body removed
POST /indexes/{indexUid}/search
- Body modified
  - Attribute added: attributesToSearchOn
POST /multi-search
- Body modified
  - Attribute modified: queries

Powered by Bump

macraig

Can we add telemetry to know when a user is searching using attributesToSearchOn?

macraig · 2023-07-03T15:29:56Z

text/0118-search-api.md

+
+- If `attributesToSearchOn` is not set or set to `null`, then the query will search on all `searchableAttributes`.
+- Sending the attributes in a different order than the order set in the settings `searchableAttributes` doesn't reorder the fields' rank for the `Attributes` ranking rule
+- 🔴 Sending a value with a different type than `Array of String`(POST), `String`(GET) or `null` for `attributesToSearchOn` returns an [invalid_attributes_to_search_on](0061-error-format-and-definitions.md#invalid_search_attributes_to_search_on) error.


What happens if you send an empty array?

Empty result

Should that be specified or is it common practice in the API?

I think that defining an empty attributesToSearchOn list means that you search in no attributes, which implies no results. Do you see any other behavior?

I guess not, I was just wondering if it might be surprising for a user to leave it empty and then be confused about getting no results

I'm more on the side of the error if the array is sent with an empty form, so the developer can't break the search and is aware of it; By doing this, we can catch it before they have to understand what's wrong and fix it; I see no point in returning 0 results, am I wrong?

Maybe we could return the hits as if the query was empty?

I'm more on the side of the error if the array is sent with an empty form, so the developer can't break the search and is aware of it; By doing this, we can catch it before they have to understand what's wrong and fix it; I see no point in returning 0 results, am I wrong?

I agree about the fact that would be useless to set [], however, it's a logical behavior from Meilisearch in my sense. Moreover, it's consistent with the searchableAttributes that accepts an empty array

Maybe we could return the hits as if the query was empty?

It doesn't seems logical to me to replace the search with a placeholder one when attributeToSearchOn is empty. 🤔

You're right @ManyTheFish; accepting an empty array is an aspect of "consistency" that we could revisit with a v2 eventually because it doesn't seem great for DX (letting the developer put himself in a situation where he/she gets nothing out of the product)

I see it as an edge case personally, so the current implementation works for me, and I'm not against it

cc @macraig (if it helps!)

+1 @gmourier , let's be consistent and revisit this when we're ready for a v2

gmourier · 2023-07-05T09:48:05Z

Don't we want a telemetry point to see if the feature is used?

ManyTheFish · 2023-07-10T08:58:01Z

@gmourier @macraig about telemetry, what about something like:

"attributes_to_search_on": {
    "total_number_of_use": 60,
}

macraig · 2023-07-10T14:11:00Z

@gmourier @macraig about telemetry, what about something like:
"attributes_to_search_on": {
    "total_number_of_use": 60,
}

@ManyTheFish how does total_number_of_use work?

open-api.yaml

3907: Add telemetry for define field to search on at query time r=dureuill a=ManyTheFish Add "attributes_to_search_on" telemetry usage counter: ```json "attributes_to_search_on": { "total_number_of_use": 12, }, ``` This measures the number of search queries that the user uses `attributesToSearchOn` field. related to meilisearch/specifications#251 ## reviewers: - `@macraig` for validating the telemetry's name - `@dureuill` for validating the code Co-authored-by: ManyTheFish <many@meilisearch.com>

Update telemetry

open-api.yaml

text/0118-search-api.md

text/0034-telemetry-policies.md

text/0061-error-format-and-definitions.md

gmourier · 2023-07-13T13:38:41Z

text/0118-search-api.md

+
+- If `attributesToSearchOn` is not set or set to `null`, then the query will search on all `searchableAttributes`.
+- Sending the attributes in a different order than the order set in the settings `searchableAttributes` doesn't reorder the fields' rank for the `Attributes` ranking rule
+- 🔴 Sending a value with a different type than `Array of String`(POST), `String`(GET) or `null` for `attributesToSearchOn` returns an [invalid_attributes_to_search_on](0061-error-format-and-definitions.md#invalid_search_attributes_to_search_on) error.


You're right @ManyTheFish; accepting an empty array is an aspect of "consistency" that we could revisit with a v2 eventually because it doesn't seem great for DX (letting the developer put himself in a situation where he/she gets nothing out of the product)

I see it as an edge case personally, so the current implementation works for me, and I'm not against it

cc @macraig (if it helps!)

…ch-time

ManyTheFish added 4 commits July 3, 2023 10:49

Update 0118-search-api.md

f5db7b6

Update 0061-error-format-and-definitions.md

705121c

Update 0118-search-api.md

6d22d58

Update open-api.yaml

97cea19

ManyTheFish marked this pull request as ready for review July 3, 2023 09:41

ManyTheFish requested a review from macraig July 3, 2023 09:41

ManyTheFish changed the title ~~Update 0118-search-api.md~~ Define fields to search on at runtime Jul 3, 2023

ManyTheFish added Implemented Feature specification has been implemented. OpenAPI Update OpenAPI specification. v1.3.0 labels Jul 3, 2023

ManyTheFish mentioned this pull request Jul 3, 2023

v1.3: Define search field at search time meilisearch/documentation#2478

Closed

3 tasks

macraig mentioned this pull request Jul 3, 2023

Release v1.3.0 #244

Merged

1 task

macraig reviewed Jul 3, 2023

View reviewed changes

gmourier added the Ready For Review Feature specification must be reviewed. label Jul 5, 2023

gmourier requested review from gmourier, maryamsulemani97 and brunoocasali July 5, 2023 09:48

ManyTheFish mentioned this pull request Jul 10, 2023

Add telemetry for define field to search on at query time meilisearch/meilisearch#3907

Merged

bidoubiwa mentioned this pull request Jul 5, 2023

Changes regarding Meilisearch v1.3.0 meilisearch/integration-guides#280

Closed

bidoubiwa reviewed Jul 10, 2023

View reviewed changes

open-api.yaml Outdated Show resolved Hide resolved

bidoubiwa mentioned this pull request Jul 10, 2023

Add attributes to search on for Meilisearch v1.3 meilisearch/meilisearch-js#1538

Merged

ManyTheFish added the Telemetry Update the telemetry collect. label Jul 13, 2023

Update 0034-telemetry-policies.md

8bf29c6

Update telemetry

ManyTheFish commented Jul 13, 2023

View reviewed changes

open-api.yaml Outdated Show resolved Hide resolved

text/0118-search-api.md Outdated Show resolved Hide resolved

text/0118-search-api.md Outdated Show resolved Hide resolved

Update open-api.yaml

eba4c93

ManyTheFish added 2 commits July 13, 2023 13:59

Update text/0118-search-api.md

12211c7

Update text/0118-search-api.md

0f97847

ManyTheFish commented Jul 13, 2023

View reviewed changes

text/0034-telemetry-policies.md Show resolved Hide resolved

gmourier reviewed Jul 13, 2023

View reviewed changes

guimachiavelli mentioned this pull request Jul 12, 2023

v1.3: Telemetry meilisearch/documentation#2492

Closed

bidoubiwa approved these changes Jul 18, 2023

View reviewed changes

brunoocasali approved these changes Jul 24, 2023

View reviewed changes

Merge branch 'release-v1.3.0' into Define-fields-to-search-on-at-sear…

015cfd1

…ch-time

macraig merged commit aeea752 into release-v1.3.0 Jul 31, 2023
2 checks passed

macraig deleted the Define-fields-to-search-on-at-search-time branch July 31, 2023 10:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define fields to search on at runtime #251

Define fields to search on at runtime #251

ManyTheFish commented Jul 3, 2023

github-actions bot commented Jul 3, 2023

macraig left a comment

macraig Jul 3, 2023

ManyTheFish Jul 3, 2023

macraig Jul 3, 2023

ManyTheFish Jul 10, 2023

macraig Jul 10, 2023

gmourier Jul 11, 2023

bidoubiwa Jul 11, 2023

ManyTheFish Jul 13, 2023 •

edited

gmourier Jul 13, 2023 •

edited

macraig Jul 13, 2023

gmourier commented Jul 5, 2023

ManyTheFish commented Jul 10, 2023

macraig commented Jul 10, 2023

gmourier Jul 13, 2023 •

edited

Define fields to search on at runtime #251

Define fields to search on at runtime #251

Conversation

ManyTheFish commented Jul 3, 2023

Summary

Changes

github-actions bot commented Jul 3, 2023

Modified (3)

macraig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ManyTheFish Jul 13, 2023 • edited

Choose a reason for hiding this comment

gmourier Jul 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gmourier commented Jul 5, 2023

ManyTheFish commented Jul 10, 2023

macraig commented Jul 10, 2023

gmourier Jul 13, 2023 • edited

Choose a reason for hiding this comment

ManyTheFish Jul 13, 2023 •

edited

gmourier Jul 13, 2023 •

edited

gmourier Jul 13, 2023 •

edited