Needs updated: Compatibility with algoliaSearch parameters

[bidoubiwa]

Compatibility

All bulletpoints that have been crossed are UI related and do not need to be tested.

Not compatible features list at the end of the issue.
Not compatible parameters start with a ❌.

search

• query: The text to search in the index
  ❗️ Not tested because completely ignored by instantSearch

• similarQuery: Overrides the query parameter and performs a more generic search that can be used to find “similar” results.
  ❗️ Not tested because usefulness is questionable

attributes

• ✅ attributesToRetrieve: Gives control over which attributes to retrieve and which not to retrieve.

  • In MeiliSearch attributesToRetrieve does not impact attributeToHighlight

• ❌ restrictSearchableAttributes: Restricts a given query to look in only a subset of your searchable attributes.
  This setting overrides searchableAttributes for specific searches, without changing the priority order of the searchableAttributes.

ranking

• ❌ relevancyStrictness: Controls the relevancy threshold below which less relevant results aren’t included in the results.

filtering

• ✅ filters: Filter the query with numeric, facet and/or tag filters. Add integration and unit tests on filters #393

  • ✅ 'attribute = value AND | OR | NOT attribute = value' // Different usage than instantSearch Docs
  • ✅ 'numeric_attribute = | != | > | >= | < | <= numeric_value'
  • ❌ 'attribute:lower_value TO higher_value'
  • ❌ 'facetName:facetValue'
  • ❌ '_tags:value'
  • ✅ 'attribute = value' // Different usage than instantSearch Docs

• ✅ facetFilters: Filter hits by facet value. Facets tests #400

• ❌ optionalFilters: Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.

• ✅ numericFilters: Filter on numeric attributes. Add integration and unit tests on filters #393

• ❌ tagFilters: Filter hits by tags.

• ❌ sumOrFiltersScores: Determines how to calculate the total score for filtering.

faceting

• ✅ facets: Facets to retrieve. Facets tests #400

• ❌ maxValuesPerFacet: Maximum number of facet values to return for each facet during a regular search.
  If you want to change the number of retrieved facet hits during a search for facet values, see maxFacetHits.

this is possible using limit in refinement-list
Example:
<ais-refinement-list limit="3" attribute="boardgamecategory" />

• ❌ facetingAfterDistinct: Force faceting to be applied after de-duplication (via the Distinct setting).

• ❌ sortFacetValuesBy: Controls how facet values are sorted.

possible using transform Items on refinements

highlighting-snippeting

• ✅ attributesToHighlight: List of attributes to highlight. Add snippet/highlight/pagination integration tests #408

  • In algolia adding attributesToHIghlight in configure conflicts with the component. It is not the case in MeiliSearch

• ✅ attributesToSnippet: List of attributes to snippet, with an optional maximum number of words to snippet. Add snippet/highlight/pagination integration tests #408

  • There is a trick needed in instantMeiliSearch to make snippet also highlighted see Is it possible to snippet and highlight in InstantMeiliSearch #407
  • snippet size of MeiliSearch is total but the one from algolia is half the final value. This description:10 will give you a string of 10 in meilisearch, but a string of 20 in algolia

• ✅ highlightPreTag: The HTML string to insert before the highlighted parts in all highlight and snippet results. Add snippet/highlight/pagination integration tests #408

• ✅ highlightPostTag: The HTML string to insert after the highlighted parts in all highlight and snippet results. Add snippet/highlight/pagination integration tests #408

• ✅ snippetEllipsisText: String used as an ellipsis indicator when a snippet is truncated. Add snippet/highlight/pagination integration tests #408

• ❌ restrictHighlightAndSnippetArrays: Restrict highlighting and snippeting to items that matched the query.

pagination

• ✅ page: Specify the page to retrieve. Add snippet/highlight/pagination integration tests #408

• ✅ hitsPerPage: Set the number of hits per page. Add snippet/highlight/pagination integration tests #408

• offset: Specify the offset of the first hit to return. Not used in instantSearch

• length: Set the number of hits to retrieve (used only with offset). Not used in instantSearch

Not Compatible

See instantSearch documentation after Pagination on this page.

• ❌ typos parameters
• ❌ geo-search parameters
• ❌ languages parameters
• ❌ advanced parameters

[meck93]

Hi @bidoubiwa

Are there plans to support offset and limit in the future?

We had a similar idea as described in ticket #521.

• We want to only fetch what is necessary i.e. what is displayed on the current page (e.g., determine by hitsPerPage). Only when the user clicks "Load more" or the next page (e.g., 2) in the pagination case, a new query should be dispatched fetching the next batch of documents. Similar to this example from Algolia: https://instantsearchjs.netlify.app/stories/?path=/story/results-infinitehits--default where "Load more" dispatches a new query. They use hitsPerPage and page to determine the correct batch of documents.
• Alternatively, we had the idea to fetch the first 20 results and once required (e.g., when navigating to the 5th page if hitsPerPage=5) another search query would be dispatched.

Thanks for your work and feedback! Let me know if the comment was placed on the wrong issue. I'll happily move it elsewhere (or to the discussion).

[bidoubiwa]

Hey @meck93 as you are suggesting a feature, an issue would have been more suited. But no worries, I opened one you can continue answering there: #569

[meck93]

hi @bidoubiwa thanks a lot for creating a new issue and for formulating it as a feature request. If you want to keep this issue clean, feel free to delete my comments.

[bidoubiwa]

Outdated and requires to much maintenance