Query suggestions approach with filter?

[sdrenth]

I'm trying to figure out how to use the query suggestions plugin in autocomplete for my specific use case.

Issue
The createQuerySuggestionsPlugin returns suggestions which do not provide any results, because the suggestion is based on index items which belong to another website.

Background information
I have a single index which contains all pages/products of two equal websites. In the frontend I'm using a filter in instantsearch to filter out the correct results on a specific key, for example "website1" or "website2".

The query suggestions index is based on the index which contains all pages/products from both websites. Ideally I would be able to pass a filter in here, so I could just create a specific query suggestions index for each individual website. Since that is not possible, is it possible to filter suggestions from the createQuerySuggestionsPlugin? So I can only retrieve suggestions which return results from either website1 or website2? Because the suggestions index itself does not contain the website key that I need to filter on:

{
  "dev_main": { // This is the main index which contains all pages/products of all websites
    "exact_nb_hits": 5,
    "facets": {
      "exact_matches": {},
      "analytics": {}
    }
  },
  "nb_words": 1,
  "popularity": 1,
  "query": "webshop",
  "objectID": "webshop"
}

I know that it would also make sense to create separate indexes for both websites, but the drawback of that would be that I need to maintain more indexes in Algolia (having to set all configurations in both indexes and I also have a few replicated indexes for sortation purposes).

[francoischalifour]

Hey! The Query Suggestions plugin does accept filters with the getSearchParams param:

const querySuggestionsPlugin = createQuerySuggestionsPlugin({
  searchClient,
  indexName: 'YOUR_INDEX_NAME',
  getSearchParams() {
    return {
      facetFilters: [
        /* YOUR_FILTERS */
      ],
    };
  },
});

If you need more advanced customization, you can still override the source's getItems function with the transformSource param.

If ever I misunderstood what you were trying to do, you can still reproduce what you currently have in this sandbox and we'll find a way to get there.

Hope this helps!

[francoischalifour]

Yes, it should be, following my first answer.

Feel free to reproduce with your data in that sandbox so we can work from there.

[sdrenth]

@francoischalifour Sorry, I was not able to provide this Sandbox code sooner. Please see this sandbox:

When contextKey is set to koivoer I expect no suggestion when typing "Aanleg" and when I change the contextKey to koi, I do expect to receive that suggestion. However, I never receive any suggestions with this filter applied:

getSearchParams() {
  return {
      filters: 'context_key:' + contextKey
  };
}

Query suggestions configuration:

[francoischalifour]

Here's the structure of one of your records:

{
  "dev_main": {
    "exact_nb_hits": 6,
    "facets": {
      "exact_matches": {},
      "analytics": {}
    }
  },
  "nb_words": 1,
  "popularity": 7,
  "query": "aanleg",
  "objectID": "aanleg"
}

You can see that contextKey is not set as a facet in your Query Suggestions index, otherwise it'd be in dev_main.facets.exact_matches.contextKey.

Once we've set it on your index, this filter should work:

filters: "dev_main.facets.exact_matches.contextKey:" + contextKey

[sdrenth]

@francoischalifour How am I supposed to add this facet in the Query Suggestions index? It's added when I add it as a category, but then it's not having any value:

{
  "dev_main": {
    "exact_nb_hits": 231,
    "facets": {
      "exact_matches": {
        "context_key": []
      },
      "analytics": {
        "context_key": []
      }
    }
  },
  "nb_words": 1,
  "popularity": 5,
  "query": "koi",
  "objectID": "koi"
}

I'm not able to find how I should do this from the documentation.

[francoischalifour]

That's not related to the Autocomplete library but to the Algolia Query Suggestions feature, so can you please contact [email protected]?

Thanks!