SynonymSet

org.sagebionetworks.repo.model.search.table.SynonymSet

A shareable OpenSearch synonym_graph (or legacy synonym) token filter. SynonymSets belong to an Organization; the qualified name {organizationName}-{name} is what a TextAnalyzer references via {"$ref": "{organizationName}-{name}"} inside its settings.filter registry map to bring this filter into the analyzer.

Example — OpenSearch native synonym syntax: a, b, c for equivalent (bidirectional) and a, b => c, d for explicit (directional) expansion. The definition field is a JSON object — paste OpenSearch examples directly without escaping:

{
  "organizationName": "biomed",
  "name": "medical_terms",
  "definition": {
    "type": "synonym_graph",
    "synonyms": [
      "tumor, neoplasm, cancer",
      "AD => Alzheimer's disease"
    ]
  }
}

Tuning suggestions:

Multi-word synonyms — prefer synonym_graph (it handles phrases correctly).
Disable bidirectional expansion (only the LHS is a synonym source): set "expand":false in the definition.
Tolerate malformed rule lines without failing the whole filter: set "lenient":true in the definition.

Cannot be deleted while any persisted resource references it. See the OpenSearch synonym_graph filter docs for the full parameter list (synonyms, format, expand, lenient, etc.).

Field	Type	Description
id	STRING	The unique ID of this synonym set.
organizationName	STRING	The name of the Organization this resource belongs to. Immutable after creation.
name	STRING	The resource name. Must start with a letter and contain only letters, digits, and underscores. Unique within the organization and immutable after creation. Used as part of the qualified name ({organizationName}-{name}) when referenced by other resources.
description	STRING	Optional description of the synonym set.
definition	OBJECT	Required. The full OpenSearch token filter definition as a JSON object, exactly as documented for the synonym_graph / synonym token filters. Synapse parses this to confirm it's valid JSON and otherwise passes it through to AOSS verbatim. AOSS Serverless does not support file-based parameters — use inline `synonyms`; AOSS rejects `synonyms_path` at index-build time.
etag	STRING	Synapse employs an Optimistic Concurrency Control (OCC) scheme.
createdOn	STRING	The date this resource was created.
createdBy	STRING	The ID of the user that created this resource.
modifiedOn	STRING	The date this resource was last modified.
modifiedBy	STRING	The ID of the user that last modified this resource.