Synonyms are a powerful tool to bridge the gap between the language users employ and the terminology within your content. By recognizing that different words can carry the same meaning depending on the context, you can significantly improve the relevance of your search results. Imagine selling movies online, and a user searches for “films” – without synonyms, they might miss out on relevant movie listings.
The synonym feature operates by creating synonym sets. These sets are collections of two or more queries that are considered semantically similar. While the terms within a set are often true synonyms, the system is flexible enough to accommodate related terms that, in your specific context, should be treated as equivalent for search purposes. Each entry in a synonym set is treated as a query, which can be a single word or a phrase.
Once you establish a synonym set, it becomes active immediately and applies to all subsequent searches performed within your search engine. Synonym sets can be easily created and managed through both an API for programmatic access and a user-friendly Dashboard interface. It’s important to note that a single synonym set can accommodate up to 32 words. Also, be aware that Precision tuning settings are not applied to queries that involve synonyms.
Implementing Synonyms via API
The /synonyms API endpoint provides a programmatic way to manage your synonym sets. You can use it to create, list, and delete synonyms as needed.
Example of Synonym Creation using API:
curl -X POST '/api/as/v1/engines/national-parks-demo/synonyms'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'
-d '{ "synonyms": ["summit", "peak", "cliff", "mountain"] }'This example demonstrates how to create a synonym set containing the terms “summit”, “peak”, “cliff”, and “mountain”. The API request is a POST request to the /synonyms endpoint, specifying the engine and providing an authorization token. The body of the request is in JSON format and contains the array of synonyms.
Example API Response:
{ "id": "syn-33dh34689rre8994g5h94i0nf4", "synonyms": [ "summit", "peak", "cliff", "mountain" ] }Upon successful creation, the API returns a response containing a unique id for the synonym set and the list of synonyms included in the set. This id is crucial for referencing the synonym set for future operations like retrieval or deletion.
For more in-depth information on available operations and parameters, consult the Synonyms API Reference.
Managing Synonyms through the Dashboard
For users who prefer a visual interface, the App Search dashboard offers an intuitive way to manage synonyms. The following steps and visual guide walk you through the process:
To access the synonym management interface, first, navigate to your desired Engine within the dashboard.
Within the Engine’s navigation menu, locate the Search Settings section. Here, you will find Synonyms listed alongside other search management tools like Curations and Relevance Tuning. Click on Synonyms to proceed.
Next, initiate the creation of a new synonym set by selecting Create a Synonym Set. You will then be presented with an input field where you can enter the queries that should be treated as synonyms.
Synonyms Interface in Dashboard:
A visual representation of creating a synonym set within the App Search dashboard.
Once you have entered all the terms for your synonym set, click Save. The newly created synonym set will be immediately activated and start influencing search results.
To remove a synonym set, you can easily do so by clicking Manage next to the set you wish to delete, and then selecting Delete. Upon deletion, the synonym set will instantly cease to have any effect on your search results.
Performance Considerations for Synonym Sets
It’s important to be mindful of the performance implications when implementing synonyms. Each defined Synonym Set requires analysis during every query to determine if any of the synonyms within the set are applicable to the search terms. Consequently, a large number of synonym sets can increase query latency and potentially lead to performance slowdowns.
To maintain optimal performance, it is recommended to consolidate your synonym sets whenever possible, aiming for fewer, more comprehensive sets. Regularly review your synonym sets and remove any that are no longer necessary or effective in improving search relevance. Strategic management of synonym sets is key to balancing enhanced search functionality with efficient search performance.
Next Steps for Optimizing Search Guidance
Leveraging Synonyms is a valuable strategy for guiding users toward the most relevant content, particularly when you have insights into the specific terms they are likely to use. To gain this valuable insight, explore the Analytics and Clickthrough endpoints. These tools provide data on user search behavior, revealing the terms users are actually searching for and how they interact with search results. This information is invaluable for identifying potential synonyms and areas for search improvement.
For even more refined control over search results and the ability to hand-curate specific outcomes for certain queries, delve into the Curations endpoint. Curations allow you to precisely define the top results for specific searches, offering an additional layer of guidance and control over the user’s search experience.
