Stopword Sets
Stopword Sets allow you to define sets of common words (such as "the", "a", "an", "is") that should be ignored during search queries. By removing these low-value terms from search processing, you can improve search relevance and reduce noise in results.
How Stopword Sets Work
A stopword set is a named container of stopword words. Each set belongs to an organization or store and is synced asynchronously. Once synced, the stopwords are applied during search query processing to filter out the specified terms.
Common Stopwords
Stopword sets contain a flat list of words to ignore:
- Common articles: "the", "a", "an"
- Prepositions: "in", "on", "at", "for"
- Conjunctions: "and", "or", "but"
Sync Status
Stopword sets are synced asynchronously. The sync status is tracked and exposed in API responses:
| Status | Description |
|---|---|
pending_sync | Set has been created or updated in MongoDB but not yet synced |
synced | Set has been successfully synced |
sync_failed | The last sync attempt failed |
pending_delete | Set is marked for deletion; a background worker will remove it |
Tenancy
Stopword sets follow the same tenancy model as other resources:
- Organization-scoped sets: Managed by the organization; apply across all stores
- Store-scoped sets: Managed by the store; apply only to that store
Stores cannot modify organization-scoped stopword sets.
📄️ Create stopword set
Create a new stopwords set.
📄️ List stopword sets
List all stopwords sets.
📄️ Get stopword set
Get a stopwords set by ID.
📄️ Update stopword set
Update the stopwords in an existing stopwords set. The locale cannot be changed.
📄️ Delete stopword set
Delete a stopword set by ID.