UpStart Commerce Search
Spell Correction

Using Alternative Indexes for Spell Correction

4min

You can create routes that use a different index to perform spell check while still retrieving search results from the primary search index.

How It Works

By specifying an alternative index for spell checking, you can optimize your search functionality without compromising the quality of your search results. The spell check operation will be performed on the specified alternative index, while the actual search results will still come from the primary search index.

Implementing Alternative Index Spell Check

To create a route with an alternative index for spell check, follow these steps:

Step 1: Create a Route with Alternative Index Spell Check

Use the following API call to create a new route with the alternative index spell check feature:

Curl


This command creates a new route with the following key components:

  • id: A unique identifier for your route (e.g., "route_name")
  • displayName: A human-readable name for your route (e.g., "Alternative Index Spell Check Route")
  • access: Set to "public" to allow general access
  • indexes: Specifies the primary search index and spell check configuration
    • id: The primary index used for search results
    • spellCheck: Configuration for spell checking
      • type: Set to "MLBased" for machine learning-based spell checking
      • alternativeIndexName: The name of the alternative index to use for spell checking

Step 2: Using the New Route

Once you've created the route with the alternative index spell check, you can use it in your search requests just like any other route. The spell check will be performed on the specified alternative index, while search results will still come from the primary index.

Benefits of Using Alternative Indexes

  1. Performance Optimization: By using a smaller, more focused index for spell checking, you can potentially improve the speed of spell check operations.
  2. Customized Spell Checking: You can create a specialized index containing only the most relevant terms for spell checking, potentially improving accuracy for your specific use case.
  3. Flexibility: This feature allows you to separate your spell check data from your main search data, giving you more control over how spell checking is performed.

By leveraging alternative indexes for spell check, you can fine-tune your search experience, potentially improving both performance and accuracy for your users.