Error codes

AI Personalization is a beta feature according to Algolia’s Terms of Service (“Beta Services”).

AI Personalization relies on valid, relevant, and well-structured Insights events to generate accurate user profiles. When you configure AI Personalization, your Insights events are checked to ensure they meet specific requirements. If they don’t, a combination of the following errors and warnings will be returned.

You must resolve any errors before continuing to configure AI Personalization.

Index errors

The following errors will be returned if the indices you want to enable AI Personalization on don’t meet the requirements.

Missing index

code: no_index

An index in your configuration doesn’t exist in your app. Ensure that the name of the index is spelled correctly or configure AI Personalization in the dashboard so you only select indices that exist.

Missing records

code: no_records

An index in your configuration doesn’t contain any records. Review your indices to ensure you are configuring the correct index. If the index you intend to use contains no records, send data to the index.

Events errors

The following errors will be returned if the events for the indices you want to enable AI Personalization on don’t meet the requirements.

Use the Events Debugger to monitor and debug the 3,000 most recent events.

AI Personalization only checks valid Insights events that were received by Algolia in the past 24 hours.

Invalid events mapping

code: invalid_events_mapping

Some events in the eventsMapping don’t exist. Ensure the names and types of the events are spelled correctly or use the dashboard to configure AI Personalization.

Mismatched object IDs

code: mismatched_object_ids

Less than 80% of events for this index, that have an objectID, correspond to a record with a matching objectID. Review the index and ensure you aren’t sending events for objects that don’t exist, were recently deleted from the index, or exist in another index.

Missing events

code: no_events

No events exist for this index. Ensure you are capturing all important events related to your search and discovery experience.

Missing user tokens

code: no_user_tokens

None of the events in this index have a userToken. Ensure you are sending a valid userToken for all events.

Unique user tokens

code: single_user_token

All the events for this index have the same userToken. Ensure you are sending a unique userToken for each user.

Invalid user tokens

code: undefined_user_tokens

All the events for this index have a userToken of undefined, anonymous, or ''. Ensure you are sending a unique userToken for each user.

Missing object IDs

code: no_object_ids

Not all the received events for this index have objectIDs. Review the index and ensure you aren’t sending events for records that don’t exist, were recently deleted from the index, or exist in another index.

Events warnings

To ensure the most accurate user profiles, avoid the following warnings related to your events. Fixing them isn’t mandatory but can be helpful.

Low number of returning users

code: low_returning_users

In the last 30 days, less than 10% of userTokens appear in an event on consecutive days. If this is unexpected, then ensure you are implementing persistent user tokens. If this matches your expectations then implement a strategy to get more users regularly returning to your site.

Missing user tokens

code: some_events_with_no_user_tokens

Some, but not all, of the events for this index have no userToken. Ensure you are sending a valid userToken for every event.

Invalid user tokens

code: some_events_with_undefined_user_tokens

Some, but not all, of the events for this index have a userToken of undefined, anonymous, or ''. Ensure you are sending a unique userToken for every user.

No event subtypes

code: no_event_subtypes

Received conversion events lack either addToCart or purchase subtypes. Ensure you are sending valid subtypes for all conversion events.

User errors

The following errors will be returned when specific user requirements haven’t been met.

Missing users with personalization enabled

code: no_users_perso_enabled

None of your users have personalization enabled. Review your index and ensure you are setting the enablePersonalization parameter to true. You can also set this parameter while setting up an A/B test

Missing users with personalization found

code: no_users_perso_found

None of your users are associated with a user profile. Ensure that you are sending a valid userToken and that users are assigned a persistent user token across sessions.

Missing users with personalization applied

code: no_users_perso_applied

None of your users have had a user profile applied to their search results. Ensure the attributes in your index match the affinities in the user profiles.

User warnings

To ensure the most accurate user profiles, avoid the following warnings related to your users. Fixing them isn’t mandatory but can be helpful.

Low number of users with personalization enabled

code: low_users_perso_enabled

Only a subset of your users have personalization enabled. Review your index and ensure you are setting the enablePersonalization parameter to true. You can also set this parameter while setting up an A/B test.

Low number of users with personalization found

code: low_users_perso_found

Only a subset of your users are associated with a user profile. Ensure that you are sending a valid userToken and that users are assigned a persistent user token across sessions.

Low number of users with personalization applied

code: low_users_perso_applied

Only a subset of your users have had a user profile applied to their search results. Ensure the attributes in your index match the affinities in the user profiles.

Queries errors

The following errors will be returned when the requirements for search queries haven’t been met.

Missing queries with personalization enabled

code: no_queries_perso_enabled

None of your search queries have personalization enabled. Review your index and ensure you are setting the enablePersonalization parameter to true. You can also set this parameter while setting up an A/B test

Missing queries with personalization found

code: no_queries_perso_found

None of your search queries are associated with a user profile. Ensure that you are sending a valid userToken and that users are assigned a persistent user token across sessions.

Missing queries with personalization applied

code: no_queries_perso_applied

None of your search queries have had a user profile applied. Ensure the attributes in your index match the affinities in the user profiles.

Queries warnings

To ensure the most accurate user profiles, avoid the following warnings related to your search queries. Fixing them isn’t mandatory but can be helpful.

Low number of queries with personalization enabled

code: low_queries_perso_enabled

Only a subset of your queries have personalization enabled. Review your index and ensure you are setting the enablePersonalization parameter to true. You can also set this parameter while setting up an A/B test

Low number of queries with personalization found

code: low_queries_perso_found

Only a subset of your queries are associated with a user profile. Ensure that you are sending a valid userToken and that users are assigned a persistent user token across sessions.

Low number of queries with personalization applied

code: low_queries_perso_applied

Only a subset of your queries have had a user profile applied. Ensure the attributes in your index match the affinities in the user profiles.