Explore related content in the Algolia Academy
NeuralSearch: quick activation
Explore related content in the Algolia Academy
NeuralSearch: explainability
Before you begin
This feature isn’t available on every plan.
Refer to your pricing plan to see if it’s included.
- You need to have uploaded your data to Algolia
- You’re sending click and conversion events from your app or website to Algolia. NeuralSearch depends on user interactions to train the underlying language model for its vector search.
Events requirements for NeuralSearch
- Minimum 1,000 click OR 100 conversion events within 30 days.
clickedObjectIDsAfterSearch
(click)convertedObjectIDsAfterSearch
(conversion)addedToCartObjectIDsAfterSearch
(conversion)purchasedObjectIDsAfterSearch
(conversion)
Set up NeuralSearch
You can activate NeuralSearch on an index in your Algolia dashboard:- Go to the Algolia dashboard and select your Algolia application.
- On the left sidebar, select Search.
- Select your Algolia index.
- Go to Configure > NeuralSearch and click Configure NeuralSearch.
- Select your event source. By default, NeuralSearch uses events from the index you selected to train the language model. If your index has replicas, you can add them as additional event sources. Click Add event sources to add these event source indices.
-
If you collected enough events in the last 30 days, you can select one of these options:
- Select Activate NeuralSearch to start the training and activate NeuralSearch for the current index.
- Select See NeuralSearch in action to create a replica index where you can test NeuralSearch.
Building the NeuralSearch index takes time and depends on your index size.
Search with NeuralSearch
Searching with NeuralSearch works the same as before, except with an increased understanding of the query. Now, instead of matching only keywords in the text, the search engine also returns results that match concepts:Keyword search | NeuralSearch | |
---|---|---|
Matches | Keywords | Concepts and keywords |
Results | Exact or similar keyword matches | Relevant results, even if the query doesn’t match keywords |
Understanding of user intent | Limited | Can anticipate intent based on the search |
Set the search mode in the API
After activating NeuralSearch in the dashboard, you can use themode
API parameter to turn NeuralSearch off: