Overview

This node operation deletes a synonym set from a specified collection in a Typesense search platform instance. It is useful for managing and maintaining the search index by removing outdated or incorrect synonym sets, which can improve search accuracy and relevance. For example, if a synonym set is no longer needed or was created by mistake, this operation allows you to delete it cleanly.

Use Case Examples

1. Deleting a synonym set named 'electronics_synonyms' from the 'products' collection to update the search behavior.
2. Removing an obsolete synonym set from a collection to prevent irrelevant search results.

Properties

Output

JSON

• success - Indicates whether the synonym set was successfully deleted (true/false).
• message - Additional information or confirmation message about the deletion operation.

Dependencies

• Requires an API key credential for authenticating with the Typesense instance.

Troubleshooting

• If the specified collection does not exist or is not accessible, the node will throw an error indicating the collection could not be found. Verify the collection name is correct and the API key has appropriate permissions.
• If the synonym set name does not exist in the selected collection, an error will be thrown. Ensure the synonym set name is valid and currently exists in the collection.
• Network or authentication errors may occur if the API key is invalid or the Typesense server is unreachable. Check credentials and network connectivity.