Typesense icon

Typesense

Interact with the Typesense search platform

Synonym → Get

AI-generated

Overview

This node interacts with the Typesense search platform to retrieve synonym sets from a specified collection. It is useful for managing and querying synonym sets within a Typesense instance, allowing users to fetch details about specific synonym sets for search optimization and data enrichment purposes.

Use Case Examples

  1. Retrieve a specific synonym set from a collection to review or update synonyms used in search queries.
  2. Fetch synonym sets to analyze or export them for external processing or backup.

Properties

Name Meaning
Collection Name Select a collection from your Typesense instance to operate on.
Synonym Set Name Select an existing synonym set within the chosen collection to retrieve.
Filter Columns Comma-separated list of column names to include in the output. Leave empty to return all columns.

Output

JSON

  • id - Identifier of the synonym set.
  • synonyms - List of synonyms included in the synonym set.
  • synonym_set_name - Name of the synonym set.
  • collection - Name of the collection the synonym set belongs to.

Dependencies

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

Troubleshooting

  • Ensure the selected collection exists and is accessible in the Typesense instance to avoid errors loading collections or synonym sets.
  • If no synonym sets are found, verify that the collection contains synonym sets and that the correct collection is selected.
  • Errors related to loading collections or synonym sets typically indicate connectivity or permission issues with the Typesense API; verify API credentials and network access.

Discussion