Synapse REST API

ColumnAnalyzerOverride

org.sagebionetworks.repo.model.search.table.ColumnAnalyzerOverride

A shareable bundle of per-column analyzer assignments. Each entry binds one column to an analyzer; that analyzer's analyzer.default drives the column's index-time analyzer and (if declared) analyzer.default_search drives its search-time analyzer — see OpenSearch's index analyzers and search analyzers. Overrides win over the SearchConfiguration's defaultAnalyzer for the named columns.

Example with $ref entries (preferred — supports reuse). Each entry's analyzer is a saved TextAnalyzer:

{
  "organizationName": "biomed",
  "name": "publication_columns",
  "overrides": [
    { "columnName": "disease_code", "analyzer": { "$ref": "biomed-acronym_exact" } },
    { "columnName": "authors",      "analyzer": { "$ref": "biomed-scientific_search" } }
  ]
}

Example with inline analyzer entries — each entry's analyzer is the bare OpenSearch settings.analysis block (allowed root keys: char_filter, tokenizer, filter, analyzer):

{
  "organizationName": "biomed",
  "name": "publication_columns_inline",
  "overrides": [
    {
      "columnName": "disease_code",
      "analyzer": {
        "analyzer": {
          "default": {
            "type": "custom",
            "tokenizer": "keyword",
            "filter": ["lowercase"]
          }
        }
      }
    },
    {
      "columnName": "authors",
      "analyzer": { "$ref": "biomed-scientific_search" }
    }
  ]
}

The analyzer field on each entry accepts a {"$ref": "{organizationName}-{name}"} reference (preferred — supports reuse) or an inline analyzer literal. Refs to SynonymSets are not permitted inside an inline analyzer literal — save a TextAnalyzer and reference it by qualified name to use synonyms. Referenced from a SearchConfiguration's columnAnalyzerOverrides by qualified name {organizationName}-{name} or inlined directly there. Entries whose columnName is not present in a given SearchIndex's schema are silently skipped — a single override resource can therefore apply to multiple indexes that share some column names. Cannot be deleted while referenced by any SearchConfiguration.

Field	Type	Description
id	STRING	The unique ID of this column analyzer override.
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.
overrides	ARRAY<ColumnAnalyzerOverrideEntry>	The per-column analyzer assignments — see ColumnAnalyzerOverrideEntry.
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.