Search Configuration

Analyzer, synonym, and configuration resources that control how a SearchIndex builds its OpenSearch index.

API reference

synapseclient.models.SearchConfiguration dataclass

Bases: OrgScopedResource

Bundles the index-wide default analyzer and per-column overrides used to build a SearchIndex.

A SearchConfiguration belongs to an Organization, referenced by organization_name. Find an Organization you already have access to with synapseclient.models.organization.list_organizations(), or create one with synapseclient.models.Organization before creating a SearchConfiguration.

Represents a Synapse SearchConfiguration.

Note: SearchConfiguration has no delete endpoint on the Synapse REST API. Once created, it cannot be removed, and its owning Organization can no longer be deleted either. Choose organization_name and name deliberately.

Create a SearchConfiguration.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfiguration

syn = Synapse()
syn.login()

config = SearchConfiguration(
    organization_name="my.existing.organization",
    name="default_config",
    description="Default search configuration for this project's indexes",
    # Reference a previously-created TextAnalyzer by its qualified name...
    default_analyzer={"$ref": "my.existing.organization-stemmed_english"},
)
config = config.store()
print(f"Created SearchConfiguration: {config.id} ({config.qualified_name})")

Get an existing SearchConfiguration by ID.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfiguration

syn = Synapse()
syn.login()

config = SearchConfiguration(id="12345").get()
print(config.name, config.default_analyzer)

Update an existing SearchConfiguration.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfiguration

syn = Synapse()
syn.login()

config = SearchConfiguration(id="12345").get()
config.column_analyzer_overrides.append(
    {"$ref": "my.existing.organization-abstract_overrides"}
)
config = config.store()
print(f"Updated SearchConfiguration etag: {config.etag}")

List SearchConfigurations in an Organization.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfiguration

syn = Synapse()
syn.login()

configs = SearchConfiguration.list(organization_name="my.existing.organization")
for config in configs:
    print(config.id, config.qualified_name)

Source code in synapseclient/models/search_management.py

@dataclass
class SearchConfiguration(OrgScopedResource):
    """Bundles the index-wide default analyzer and per-column overrides used to
    build a SearchIndex.

    A SearchConfiguration belongs to an Organization, referenced by
    `organization_name`. Find an Organization you already have access to with
    `synapseclient.models.organization.list_organizations()`, or create one with
    `synapseclient.models.Organization` before creating a SearchConfiguration.

    Represents a [Synapse SearchConfiguration](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/SearchConfiguration.html).

    Note: SearchConfiguration has no delete endpoint on the Synapse REST API.
    Once created, it cannot be removed, and its owning Organization can no
    longer be deleted either. Choose `organization_name` and `name` deliberately.

    Example: Create a SearchConfiguration.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfiguration

        syn = Synapse()
        syn.login()

        config = SearchConfiguration(
            organization_name="my.existing.organization",
            name="default_config",
            description="Default search configuration for this project's indexes",
            # Reference a previously-created TextAnalyzer by its qualified name...
            default_analyzer={"$ref": "my.existing.organization-stemmed_english"},
        )
        config = config.store()
        print(f"Created SearchConfiguration: {config.id} ({config.qualified_name})")
        ```

    Example: Get an existing SearchConfiguration by ID.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfiguration

        syn = Synapse()
        syn.login()

        config = SearchConfiguration(id="12345").get()
        print(config.name, config.default_analyzer)
        ```

    Example: Update an existing SearchConfiguration.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfiguration

        syn = Synapse()
        syn.login()

        config = SearchConfiguration(id="12345").get()
        config.column_analyzer_overrides.append(
            {"$ref": "my.existing.organization-abstract_overrides"}
        )
        config = config.store()
        print(f"Updated SearchConfiguration etag: {config.etag}")
        ```

    Example: List SearchConfigurations in an Organization.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfiguration

        syn = Synapse()
        syn.login()

        configs = SearchConfiguration.list(organization_name="my.existing.organization")
        for config in configs:
            print(config.id, config.qualified_name)
        ```
    """

    _CREATE_FN = staticmethod(create_search_configuration)
    _GET_FN = staticmethod(get_search_configuration)
    _UPDATE_FN = staticmethod(update_search_configuration)
    _LIST_FN = staticmethod(list_search_configurations)

    id: Optional[str] = None
    """The unique ID of this search configuration."""

    organization_name: Optional[str] = None
    """The name of the Organization this resource belongs to. Immutable after
    creation."""

    name: Optional[str] = None
    """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: Optional[str] = None
    """Optional description."""

    default_analyzer: Optional[Union[AnalyzerRef, Dict[str, Any]]] = None
    """Optional. The analyzer that supplies this index's `analysis.analyzer.default`
    slot. Either a reference to a saved TextAnalyzer written as
    `{"$ref": "{organizationName}-{name}"}` (see
    [AnalyzerRef][synapseclient.models.search_dsl.AnalyzerRef]), or an inline
    OpenSearch [`settings.analysis`](https://docs.opensearch.org/latest/analyzers/)
    block."""
    column_analyzer_overrides: Optional[List[Union[AnalyzerRef, Dict[str, Any]]]] = (
        field(default_factory=list)
    )
    """Optional ordered list of ColumnAnalyzerOverride entries. Each entry is
    either a reference `{"$ref": "{organizationName}-{name}"}` (see
    [AnalyzerRef][synapseclient.models.search_dsl.AnalyzerRef]) or an inline
    ColumnAnalyzerOverride literal."""

    etag: Optional[str] = None
    """Synapse employs an Optimistic Concurrency Control (OCC) scheme."""

    created_on: Optional[str] = None
    """The date this resource was created."""

    created_by: Optional[str] = None
    """The ID of the user that created this resource."""

    modified_on: Optional[str] = None
    """The date this resource was last modified."""

    modified_by: Optional[str] = None
    """The ID of the user that last modified this resource."""

    @property
    def qualified_name(self) -> Optional[str]:
        if self.organization_name and self.name:
            return f"{self.organization_name}-{self.name}"
        return None

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.id = data.get("id", None)
        self.organization_name = data.get("organizationName", None)
        self.name = data.get("name", None)
        self.description = data.get("description", None)
        self.default_analyzer = data.get("defaultAnalyzer", None)
        self.column_analyzer_overrides = data.get("columnAnalyzerOverrides", []) or []
        self.etag = data.get("etag", None)
        self.created_on = data.get("createdOn", None)
        self.created_by = data.get("createdBy", None)
        self.modified_on = data.get("modifiedOn", None)
        self.modified_by = data.get("modifiedBy", None)
        return self

    def to_synapse_request(self) -> Dict[str, Any]:
        body = {
            "id": self.id,
            "organizationName": self.organization_name,
            "name": self.name,
            "description": self.description,
            "defaultAnalyzer": self.default_analyzer,
            "columnAnalyzerOverrides": self.column_analyzer_overrides or None,
            "etag": self.etag,
        }
        delete_none_keys(body)
        return body

Methods:

store

store(*, synapse_client: Optional[Synapse] = None) -> Self

Create this resource, or update it if it already has an ID.

Source code in synapseclient/models/search_management.py

def store(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Create this resource, or update it if it already has an ID."""
    return self

get

get(*, synapse_client: Optional[Synapse] = None) -> Self

Fetch this resource from Synapse by its ID.

Source code in synapseclient/models/search_management.py

def get(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Fetch this resource from Synapse by its ID."""
    return self

list

list(organization_name: Optional[str] = None, *, synapse_client: Optional[Synapse] = None) -> List[Self]

List resources of this type, optionally filtered by organization.

Source code in synapseclient/models/search_management.py

def list(
    self,
    organization_name: Optional[str] = None,
    *,
    synapse_client: Optional["Synapse"] = None,
) -> List["Self"]:
    """List resources of this type, optionally filtered by organization."""
    return []

synapseclient.models.TextAnalyzer dataclass

Bases: OrgScopedResource

A shareable, named OpenSearch custom analyzer. Used to configure how text is tokenized for a search index.

A TextAnalyzer belongs to an Organization, referenced by organization_name. Find an Organization you already have access to with synapseclient.models.organization.list_organizations(), or create one with synapseclient.models.Organization before creating a TextAnalyzer.

Represents a Synapse TextAnalyzer.

Note: TextAnalyzer has no delete endpoint on the Synapse REST API. Once created, it cannot be removed, and its owning Organization can no longer be deleted either. Choose organization_name and name deliberately.

Create a TextAnalyzer.

 

from synapseclient import Synapse
from synapseclient.models import TextAnalyzer

syn = Synapse()
syn.login()

analyzer = TextAnalyzer(
    organization_name="my.existing.organization",
    name="stemmed_english",
    description="English analyzer with stemming and lowercase filtering",
    settings={
        "analyzer": {
            "default": {
                "type": "custom",
                "tokenizer": "standard",
                "filter": ["lowercase", "porter_stem"],
            }
        }
    },
)
analyzer = analyzer.store()
print(f"Created TextAnalyzer: {analyzer.id} ({analyzer.qualified_name})")

Get an existing TextAnalyzer by ID.

 

from synapseclient import Synapse
from synapseclient.models import TextAnalyzer

syn = Synapse()
syn.login()

analyzer = TextAnalyzer(id="12345").get()
print(analyzer.name, analyzer.settings)

Update an existing TextAnalyzer.

 

from synapseclient import Synapse
from synapseclient.models import TextAnalyzer

syn = Synapse()
syn.login()

analyzer = TextAnalyzer(id="12345").get()
analyzer.description = "Updated description"
analyzer.settings["analyzer"]["default"]["filter"].append("asciifolding")
analyzer = analyzer.store()
print(f"Updated TextAnalyzer etag: {analyzer.etag}")

List TextAnalyzers in an Organization.

 

from synapseclient import Synapse
from synapseclient.models import TextAnalyzer

syn = Synapse()
syn.login()

analyzers = TextAnalyzer.list(organization_name="my.existing.organization")
for analyzer in analyzers:
    print(analyzer.id, analyzer.qualified_name)

Source code in synapseclient/models/search_management.py

@dataclass
class TextAnalyzer(OrgScopedResource):
    """A shareable, named OpenSearch custom analyzer. Used to configure how text
    is tokenized for a search index.

    A TextAnalyzer belongs to an Organization, referenced by `organization_name`.
    Find an Organization you already have access to with
    `synapseclient.models.organization.list_organizations()`, or create one with
    `synapseclient.models.Organization` before creating a TextAnalyzer.

    Represents a [Synapse TextAnalyzer](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/TextAnalyzer.html).

    Note: TextAnalyzer has no delete endpoint on the Synapse REST API. Once
    created, it cannot be removed, and its owning Organization can no longer be
    deleted either. Choose `organization_name` and `name` deliberately.

    Example: Create a TextAnalyzer.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import TextAnalyzer

        syn = Synapse()
        syn.login()

        analyzer = TextAnalyzer(
            organization_name="my.existing.organization",
            name="stemmed_english",
            description="English analyzer with stemming and lowercase filtering",
            settings={
                "analyzer": {
                    "default": {
                        "type": "custom",
                        "tokenizer": "standard",
                        "filter": ["lowercase", "porter_stem"],
                    }
                }
            },
        )
        analyzer = analyzer.store()
        print(f"Created TextAnalyzer: {analyzer.id} ({analyzer.qualified_name})")
        ```

    Example: Get an existing TextAnalyzer by ID.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import TextAnalyzer

        syn = Synapse()
        syn.login()

        analyzer = TextAnalyzer(id="12345").get()
        print(analyzer.name, analyzer.settings)
        ```

    Example: Update an existing TextAnalyzer.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import TextAnalyzer

        syn = Synapse()
        syn.login()

        analyzer = TextAnalyzer(id="12345").get()
        analyzer.description = "Updated description"
        analyzer.settings["analyzer"]["default"]["filter"].append("asciifolding")
        analyzer = analyzer.store()
        print(f"Updated TextAnalyzer etag: {analyzer.etag}")
        ```

    Example: List TextAnalyzers in an Organization.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import TextAnalyzer

        syn = Synapse()
        syn.login()

        analyzers = TextAnalyzer.list(organization_name="my.existing.organization")
        for analyzer in analyzers:
            print(analyzer.id, analyzer.qualified_name)
        ```
    """

    _CREATE_FN = staticmethod(create_text_analyzer)
    _GET_FN = staticmethod(get_text_analyzer)
    _UPDATE_FN = staticmethod(update_text_analyzer)
    _LIST_FN = staticmethod(list_text_analyzers)

    id: Optional[str] = None
    """The unique immutable ID for this text analyzer."""

    organization_name: Optional[str] = None
    """The name of the organization that owns this analyzer.
    Immutable after creation."""

    name: Optional[str] = None
    """The name of this analyzer. Must start with a letter and
    contain only letters, digits, and underscores; unique within the
    organization."""

    description: Optional[str] = None
    """Optional description of this analyzer."""

    settings: Optional[Dict[str, Any]] = None
    """Required. JSON object holding the *contents of* the `settings.analysis`
    block of an OpenSearch
    [create-index](https://docs.opensearch.org/latest/api-reference/index-apis/create-index/)
    request body. Allowed root keys are `char_filter`, `tokenizer`, `filter`,
    and `analyzer`; the inner `analyzer` map must declare exactly one `default`
    entry (and optionally `default_search`). A `{"$ref": "{org}-{name}"}` entry
    inside the `filter` registry resolves to a SynonymSet at index-build time.
    Carried as a raw JSON object -- the Synapse API does not constrain it
    further. See [analyzers](https://docs.opensearch.org/latest/analyzers/)
    for the available tokenizers, token filters, and character filters."""

    etag: Optional[str] = None
    """Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle
    concurrent updates. The eTag changes every time this analyzer is updated;
    it is used to detect when a client's copy is out-of-date."""

    created_on: Optional[str] = None
    """The date on which this analyzer was created."""

    created_by: Optional[str] = None
    """The ID of the Synapse user who created this analyzer."""

    modified_on: Optional[str] = None
    """The date on which this analyzer was last modified."""

    modified_by: Optional[str] = None
    """The ID of the Synapse user who last modified this analyzer."""

    @property
    def qualified_name(self) -> Optional[str]:
        """The qualified name '{organizationName}-{name}' used to reference
        this analyzer from a SearchConfiguration."""
        if self.organization_name and self.name:
            return f"{self.organization_name}-{self.name}"
        return None

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.id = data.get("id", None)
        self.organization_name = data.get("organizationName", None)
        self.name = data.get("name", None)
        self.description = data.get("description", None)
        self.settings = data.get("settings", None)
        self.etag = data.get("etag", None)
        self.created_on = data.get("createdOn", None)
        self.created_by = data.get("createdBy", None)
        self.modified_on = data.get("modifiedOn", None)
        self.modified_by = data.get("modifiedBy", None)
        return self

    def to_synapse_request(self) -> Dict[str, Any]:
        body = {
            "id": self.id,
            "organizationName": self.organization_name,
            "name": self.name,
            "description": self.description,
            "settings": self.settings,
            "etag": self.etag,
        }
        delete_none_keys(body)
        return body

Methods:

store

store(*, synapse_client: Optional[Synapse] = None) -> Self

Create this resource, or update it if it already has an ID.

Source code in synapseclient/models/search_management.py

def store(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Create this resource, or update it if it already has an ID."""
    return self

get

get(*, synapse_client: Optional[Synapse] = None) -> Self

Fetch this resource from Synapse by its ID.

Source code in synapseclient/models/search_management.py

def get(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Fetch this resource from Synapse by its ID."""
    return self

list

list(organization_name: Optional[str] = None, *, synapse_client: Optional[Synapse] = None) -> List[Self]

List resources of this type, optionally filtered by organization.

Source code in synapseclient/models/search_management.py

def list(
    self,
    organization_name: Optional[str] = None,
    *,
    synapse_client: Optional["Synapse"] = None,
) -> List["Self"]:
    """List resources of this type, optionally filtered by organization."""
    return []

synapseclient.models.SynonymSet dataclass

Bases: OrgScopedResource

A shareable OpenSearch synonym_graph (or legacy synonym) token filter. Referenced by qualified name {organizationName}-{name} from a TextAnalyzer's settings.filter registry map via {"$ref": "{organizationName}-{name}"}.

A SynonymSet belongs to an Organization, referenced by organization_name. Find an Organization you already have access to with synapseclient.models.organization.list_organizations(), or create one with synapseclient.models.Organization before creating a SynonymSet.

Represents a Synapse SynonymSet.

Note: SynonymSet has no delete endpoint on the Synapse REST API. Once created, it cannot be removed, and its owning Organization can no longer be deleted either. Choose organization_name and name deliberately.

Create a SynonymSet.

 

from synapseclient import Synapse
from synapseclient.models import SynonymSet

syn = Synapse()
syn.login()

synonyms = SynonymSet(
    organization_name="my.existing.organization",
    name="disease_synonyms",
    description="Common synonyms for disease terms",
    definition={
        "type": "synonym_graph",
        "synonyms": [
            # comma-separated = equivalence set, matches either way
            "tumor, neoplasm, cancer",
            # "=>" = one-way mapping, "AD" expands to the right side only
            "AD => Alzheimer's disease",
        ],
    },
)
synonyms = synonyms.store()
print(f"Created SynonymSet: {synonyms.id} ({synonyms.qualified_name})")

Get an existing SynonymSet by ID.

 

from synapseclient import Synapse
from synapseclient.models import SynonymSet

syn = Synapse()
syn.login()

synonyms = SynonymSet(id="12345").get()
print(synonyms.name, synonyms.definition)

Update an existing SynonymSet.

 

from synapseclient import Synapse
from synapseclient.models import SynonymSet

syn = Synapse()
syn.login()

synonyms = SynonymSet(id="12345").get()
synonyms.definition["synonyms"].append("MI, myocardial infarction, heart attack")
synonyms = synonyms.store()
print(f"Updated SynonymSet etag: {synonyms.etag}")

List SynonymSets in an Organization.

 

from synapseclient import Synapse
from synapseclient.models import SynonymSet

syn = Synapse()
syn.login()

synonym_sets = SynonymSet.list(organization_name="my.existing.organization")
for synonyms in synonym_sets:
    print(synonyms.id, synonyms.qualified_name)

Source code in synapseclient/models/search_management.py

@dataclass
class SynonymSet(OrgScopedResource):
    """A shareable OpenSearch synonym_graph (or legacy synonym) token filter.
    Referenced by qualified name `{organizationName}-{name}` from a TextAnalyzer's
    `settings.filter` registry map via `{"$ref": "{organizationName}-{name}"}`.

    A SynonymSet belongs to an Organization, referenced by `organization_name`.
    Find an Organization you already have access to with
    `synapseclient.models.organization.list_organizations()`, or create one with
    `synapseclient.models.Organization` before creating a SynonymSet.

    Represents a [Synapse SynonymSet](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/SynonymSet.html).

    Note: SynonymSet has no delete endpoint on the Synapse REST API. Once
    created, it cannot be removed, and its owning Organization can no longer be
    deleted either. Choose `organization_name` and `name` deliberately.

    Example: Create a SynonymSet.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SynonymSet

        syn = Synapse()
        syn.login()

        synonyms = SynonymSet(
            organization_name="my.existing.organization",
            name="disease_synonyms",
            description="Common synonyms for disease terms",
            definition={
                "type": "synonym_graph",
                "synonyms": [
                    # comma-separated = equivalence set, matches either way
                    "tumor, neoplasm, cancer",
                    # "=>" = one-way mapping, "AD" expands to the right side only
                    "AD => Alzheimer's disease",
                ],
            },
        )
        synonyms = synonyms.store()
        print(f"Created SynonymSet: {synonyms.id} ({synonyms.qualified_name})")
        ```

    Example: Get an existing SynonymSet by ID.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SynonymSet

        syn = Synapse()
        syn.login()

        synonyms = SynonymSet(id="12345").get()
        print(synonyms.name, synonyms.definition)
        ```

    Example: Update an existing SynonymSet.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SynonymSet

        syn = Synapse()
        syn.login()

        synonyms = SynonymSet(id="12345").get()
        synonyms.definition["synonyms"].append("MI, myocardial infarction, heart attack")
        synonyms = synonyms.store()
        print(f"Updated SynonymSet etag: {synonyms.etag}")
        ```

    Example: List SynonymSets in an Organization.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SynonymSet

        syn = Synapse()
        syn.login()

        synonym_sets = SynonymSet.list(organization_name="my.existing.organization")
        for synonyms in synonym_sets:
            print(synonyms.id, synonyms.qualified_name)
        ```
    """

    _CREATE_FN = staticmethod(create_synonym_set)
    _GET_FN = staticmethod(get_synonym_set)
    _UPDATE_FN = staticmethod(update_synonym_set)
    _LIST_FN = staticmethod(list_synonym_sets)

    id: Optional[str] = None
    """The unique ID of this synonym set."""

    organization_name: Optional[str] = None
    """The name of the Organization this resource belongs to. Immutable after
    creation."""

    name: Optional[str] = None
    """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: Optional[str] = None
    """Optional description of the synonym set."""

    definition: Optional[Dict[str, Any]] = None
    """Required. The full OpenSearch token filter definition as a JSON object,
    exactly as documented for the
    [`synonym_graph`](https://docs.opensearch.org/latest/analyzers/token-filters/synonym-graph/)
    / [`synonym`](https://docs.opensearch.org/latest/analyzers/token-filters/synonym/)
    token filters, e.g. `{"type": "synonym_graph", "synonyms":
    ["tumor, neoplasm, cancer", "AD => Alzheimer's disease"]}`. Carried as a raw
    JSON object -- the Synapse API does not constrain it further."""

    etag: Optional[str] = None
    """Synapse employs an Optimistic Concurrency Control (OCC) scheme."""

    created_on: Optional[str] = None
    """The date this resource was created."""

    created_by: Optional[str] = None
    """The ID of the user that created this resource."""

    modified_on: Optional[str] = None
    """The date this resource was last modified."""

    modified_by: Optional[str] = None
    """The ID of the user that last modified this resource."""

    @property
    def qualified_name(self) -> Optional[str]:
        if self.organization_name and self.name:
            return f"{self.organization_name}-{self.name}"
        return None

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.id = data.get("id", None)
        self.organization_name = data.get("organizationName", None)
        self.name = data.get("name", None)
        self.description = data.get("description", None)
        self.definition = data.get("definition", None)
        self.etag = data.get("etag", None)
        self.created_on = data.get("createdOn", None)
        self.created_by = data.get("createdBy", None)
        self.modified_on = data.get("modifiedOn", None)
        self.modified_by = data.get("modifiedBy", None)
        return self

    def to_synapse_request(self) -> Dict[str, Any]:
        body = {
            "id": self.id,
            "organizationName": self.organization_name,
            "name": self.name,
            "description": self.description,
            "definition": self.definition,
            "etag": self.etag,
        }
        delete_none_keys(body)
        return body

Methods:

store

store(*, synapse_client: Optional[Synapse] = None) -> Self

Create this resource, or update it if it already has an ID.

Source code in synapseclient/models/search_management.py

def store(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Create this resource, or update it if it already has an ID."""
    return self

get

get(*, synapse_client: Optional[Synapse] = None) -> Self

Fetch this resource from Synapse by its ID.

Source code in synapseclient/models/search_management.py

def get(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Fetch this resource from Synapse by its ID."""
    return self

list

list(organization_name: Optional[str] = None, *, synapse_client: Optional[Synapse] = None) -> List[Self]

List resources of this type, optionally filtered by organization.

Source code in synapseclient/models/search_management.py

def list(
    self,
    organization_name: Optional[str] = None,
    *,
    synapse_client: Optional["Synapse"] = None,
) -> List["Self"]:
    """List resources of this type, optionally filtered by organization."""
    return []

synapseclient.models.ColumnAnalyzerOverride dataclass

Bases: OrgScopedResource

A shareable bundle of per-column analyzer assignments. Each entry binds one column to an analyzer;

A ColumnAnalyzerOverride belongs to an Organization, referenced by organization_name. Find an Organization you already have access to with synapseclient.models.organization.list_organizations(), or create one with synapseclient.models.Organization before creating a ColumnAnalyzerOverride.

Represents a Synapse ColumnAnalyzerOverride.

Note: ColumnAnalyzerOverride has no delete endpoint on the Synapse REST API. Once created, it cannot be removed, and its owning Organization can no longer be deleted either. Choose organization_name and name deliberately.

Create a ColumnAnalyzerOverride.

 

from synapseclient import Synapse
from synapseclient.models import ColumnAnalyzerOverride, ColumnAnalyzerOverrideEntry

syn = Synapse()
syn.login()

override = ColumnAnalyzerOverride(
    organization_name="my.existing.organization",
    name="disease_column_overrides",
    description="Use a keyword analyzer for the disease_code column",
    overrides=[
        ColumnAnalyzerOverrideEntry(
            column_name="disease_code",
            analyzer={"analyzer": {"default": {"type": "keyword"}}},
        ),
    ],
)
override = override.store()
print(f"Created ColumnAnalyzerOverride: {override.id} ({override.qualified_name})")

Get an existing ColumnAnalyzerOverride by ID.

 

from synapseclient import Synapse
from synapseclient.models import ColumnAnalyzerOverride

syn = Synapse()
syn.login()

override = ColumnAnalyzerOverride(id="12345").get()
print(override.name, override.overrides)

Update an existing ColumnAnalyzerOverride.

 

from synapseclient import Synapse
from synapseclient.models import ColumnAnalyzerOverride, ColumnAnalyzerOverrideEntry

syn = Synapse()
syn.login()

override = ColumnAnalyzerOverride(id="12345").get()
override.overrides.append(
    ColumnAnalyzerOverrideEntry(
        column_name="title",
        analyzer={"analyzer": {"default": {"type": "standard"}}},
    )
)
override = override.store()
print(f"Updated ColumnAnalyzerOverride etag: {override.etag}")

List ColumnAnalyzerOverrides in an Organization.

 

from synapseclient import Synapse
from synapseclient.models import ColumnAnalyzerOverride

syn = Synapse()
syn.login()

overrides = ColumnAnalyzerOverride.list(organization_name="my.existing.organization")
for override in overrides:
    print(override.id, override.qualified_name)

Source code in synapseclient/models/search_management.py

@dataclass
class ColumnAnalyzerOverride(OrgScopedResource):
    """A shareable bundle of per-column analyzer assignments. Each entry binds one column to an analyzer;

    A ColumnAnalyzerOverride belongs to an Organization, referenced by
    `organization_name`. Find an Organization you already have access to with
    `synapseclient.models.organization.list_organizations()`, or create one with
    `synapseclient.models.Organization` before creating a ColumnAnalyzerOverride.

    Represents a [Synapse ColumnAnalyzerOverride](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/ColumnAnalyzerOverride.html).

    Note: ColumnAnalyzerOverride has no delete endpoint on the Synapse REST API.
    Once created, it cannot be removed, and its owning Organization can no
    longer be deleted either. Choose `organization_name` and `name` deliberately.

    Example: Create a ColumnAnalyzerOverride.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import ColumnAnalyzerOverride, ColumnAnalyzerOverrideEntry

        syn = Synapse()
        syn.login()

        override = ColumnAnalyzerOverride(
            organization_name="my.existing.organization",
            name="disease_column_overrides",
            description="Use a keyword analyzer for the disease_code column",
            overrides=[
                ColumnAnalyzerOverrideEntry(
                    column_name="disease_code",
                    analyzer={"analyzer": {"default": {"type": "keyword"}}},
                ),
            ],
        )
        override = override.store()
        print(f"Created ColumnAnalyzerOverride: {override.id} ({override.qualified_name})")
        ```

    Example: Get an existing ColumnAnalyzerOverride by ID.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import ColumnAnalyzerOverride

        syn = Synapse()
        syn.login()

        override = ColumnAnalyzerOverride(id="12345").get()
        print(override.name, override.overrides)
        ```

    Example: Update an existing ColumnAnalyzerOverride.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import ColumnAnalyzerOverride, ColumnAnalyzerOverrideEntry

        syn = Synapse()
        syn.login()

        override = ColumnAnalyzerOverride(id="12345").get()
        override.overrides.append(
            ColumnAnalyzerOverrideEntry(
                column_name="title",
                analyzer={"analyzer": {"default": {"type": "standard"}}},
            )
        )
        override = override.store()
        print(f"Updated ColumnAnalyzerOverride etag: {override.etag}")
        ```

    Example: List ColumnAnalyzerOverrides in an Organization.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import ColumnAnalyzerOverride

        syn = Synapse()
        syn.login()

        overrides = ColumnAnalyzerOverride.list(organization_name="my.existing.organization")
        for override in overrides:
            print(override.id, override.qualified_name)
        ```
    """

    _CREATE_FN = staticmethod(create_column_analyzer_override)
    _GET_FN = staticmethod(get_column_analyzer_override)
    _UPDATE_FN = staticmethod(update_column_analyzer_override)
    _LIST_FN = staticmethod(list_column_analyzer_overrides)

    id: Optional[str] = None
    """The unique ID of this column analyzer override."""

    organization_name: Optional[str] = None
    """The name of the Organization this resource belongs to. Immutable after
    creation."""

    name: Optional[str] = None
    """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: Optional[str] = None
    """Optional description."""

    overrides: Optional[List[ColumnAnalyzerOverrideEntry]] = field(default_factory=list)
    """The per-column analyzer assignments -- see ColumnAnalyzerOverrideEntry."""

    etag: Optional[str] = None
    """Synapse employs an Optimistic Concurrency Control (OCC) scheme."""

    created_on: Optional[str] = None
    """The date this resource was created."""

    created_by: Optional[str] = None
    """The ID of the user that created this resource."""

    modified_on: Optional[str] = None
    """The date this resource was last modified."""

    modified_by: Optional[str] = None
    """The ID of the user that last modified this resource."""

    @property
    def qualified_name(self) -> Optional[str]:
        if self.organization_name and self.name:
            return f"{self.organization_name}-{self.name}"
        return None

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.id = data.get("id", None)
        self.organization_name = data.get("organizationName", None)
        self.name = data.get("name", None)
        self.description = data.get("description", None)
        self.overrides = [
            ColumnAnalyzerOverrideEntry().fill_from_dict(o)
            for o in data.get("overrides", []) or []
        ]
        self.etag = data.get("etag", None)
        self.created_on = data.get("createdOn", None)
        self.created_by = data.get("createdBy", None)
        self.modified_on = data.get("modifiedOn", None)
        self.modified_by = data.get("modifiedBy", None)
        return self

    def to_synapse_request(self) -> Dict[str, Any]:
        body = {
            "id": self.id,
            "organizationName": self.organization_name,
            "name": self.name,
            "description": self.description,
            "overrides": (
                [o.to_synapse_request() for o in self.overrides]
                if self.overrides
                else None
            ),
            "etag": self.etag,
        }
        delete_none_keys(body)
        return body

Methods:

store

store(*, synapse_client: Optional[Synapse] = None) -> Self

Create this resource, or update it if it already has an ID.

Source code in synapseclient/models/search_management.py

def store(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Create this resource, or update it if it already has an ID."""
    return self

get

get(*, synapse_client: Optional[Synapse] = None) -> Self

Fetch this resource from Synapse by its ID.

Source code in synapseclient/models/search_management.py

def get(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Fetch this resource from Synapse by its ID."""
    return self

list

list(organization_name: Optional[str] = None, *, synapse_client: Optional[Synapse] = None) -> List[Self]

List resources of this type, optionally filtered by organization.

Source code in synapseclient/models/search_management.py

def list(
    self,
    organization_name: Optional[str] = None,
    *,
    synapse_client: Optional["Synapse"] = None,
) -> List["Self"]:
    """List resources of this type, optionally filtered by organization."""
    return []

synapseclient.models.SearchConfigBinding dataclass

Bases: SearchConfigBindingSynchronousProtocol

Attaches a SearchConfiguration to an entity. When a SearchIndex is built, the effective SearchConfiguration is resolved by walking up the entity hierarchy (entity -> folder -> project) and using the first binding found.

Represents a Synapse SearchConfigBinding.

Source code in synapseclient/models/search_management.py

@dataclass
@async_to_sync
class SearchConfigBinding(SearchConfigBindingSynchronousProtocol):
    """Attaches a SearchConfiguration to an entity. When a SearchIndex is built,
    the effective SearchConfiguration is resolved by walking up the entity
    hierarchy (entity -> folder -> project) and using the first binding found.

    Represents a [Synapse SearchConfigBinding](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/SearchConfigBinding.html).
    """

    bind_id: Optional[str] = None
    """The unique ID of this binding."""

    search_configuration_id: Optional[str] = None
    """The ID of the SearchConfiguration bound to this entity."""

    object_id: Optional[str] = None
    """The ID of the entity this configuration is bound to."""

    object_type: Optional[str] = None
    """The type of the object this configuration is bound to."""

    created_by: Optional[str] = None
    """The ID of the user that created this binding."""

    created_on: Optional[str] = None
    """The date this binding was created."""

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.bind_id = data.get("bindId", None)
        self.search_configuration_id = data.get("searchConfigurationId", None)
        self.object_id = data.get("objectId", None)
        self.object_type = data.get("objectType", None)
        self.created_by = data.get("createdBy", None)
        self.created_on = data.get("createdOn", None)
        return self

    async def store_async(
        self, *, synapse_client: Optional["Synapse"] = None
    ) -> "Self":
        """Bind ``search_configuration_id`` to the entity ``object_id``. Replaces
        any existing binding on that entity.

        Arguments:
            synapse_client: If not passed in and caching was not disabled by
                `Synapse.allow_client_caching(False)` this will use the last created
                instance from the Synapse class constructor.

        Returns:
            Itself, populated from the created SearchConfigBinding.

        Raises:
            ValueError: If ``object_id`` or ``search_configuration_id`` is not set.

        Example: Bind a SearchConfiguration to a Project.
             

            ```python
            from synapseclient import Synapse
            from synapseclient.models import SearchConfigBinding

            syn = Synapse()
            syn.login()

            binding = SearchConfigBinding(
                object_id="syn12345",
                search_configuration_id="6789",
            )
            binding = binding.store()
            print(f"Bound SearchConfiguration {binding.search_configuration_id} "
                  f"to {binding.object_id}")
            ```
        """
        if not self.object_id:
            raise ValueError("SearchConfigBinding must have an object_id set.")
        if not self.search_configuration_id:
            raise ValueError(
                "SearchConfigBinding must have a search_configuration_id set."
            )
        result = await bind_search_config_to_entity(
            self.object_id,
            self.search_configuration_id,
            synapse_client=synapse_client,
        )
        return self.fill_from_dict(result)

    async def get_async(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
        """Get the effective binding for the entity ``object_id``, resolved by
        walking up the entity hierarchy.

        Arguments:
            synapse_client: If not passed in and caching was not disabled by
                `Synapse.allow_client_caching(False)` this will use the last created
                instance from the Synapse class constructor.

        Returns:
            Itself, populated from the resolved SearchConfigBinding.

        Raises:
            ValueError: If ``object_id`` is not set.

        Example: Get the effective binding for a Project.
             

            ```python
            from synapseclient import Synapse
            from synapseclient.models import SearchConfigBinding

            syn = Synapse()
            syn.login()

            binding = SearchConfigBinding(object_id="syn12345").get()
            print(binding.search_configuration_id)
            ```
        """
        if not self.object_id:
            raise ValueError("SearchConfigBinding must have an object_id set.")
        result = await get_search_config_binding(
            self.object_id, synapse_client=synapse_client
        )
        return self.fill_from_dict(result)

    async def delete_async(self, *, synapse_client: Optional["Synapse"] = None) -> None:
        """Clear the binding on the entity ``object_id``.

        Arguments:
            synapse_client: If not passed in and caching was not disabled by
                `Synapse.allow_client_caching(False)` this will use the last created
                instance from the Synapse class constructor.

        Raises:
            ValueError: If ``object_id`` is not set.

        Example: Clear the binding on a Project.
             

            ```python
            from synapseclient import Synapse
            from synapseclient.models import SearchConfigBinding

            syn = Synapse()
            syn.login()

            SearchConfigBinding(object_id="syn12345").delete()
            ```
        """
        if not self.object_id:
            raise ValueError("SearchConfigBinding must have an object_id set.")
        await clear_search_config_binding(self.object_id, synapse_client=synapse_client)

Methods:

store

store(*, synapse_client: Optional[Synapse] = None) -> Self

Bind search_configuration_id to the entity object_id. Replaces any existing binding on that entity.

PARAMETER	DESCRIPTION
synapse_client	If not passed in and caching was not disabled by Synapse.allow_client_caching(False) this will use the last created instance from the Synapse class constructor. TYPE: Optional[Synapse] DEFAULT: None

RETURNS	DESCRIPTION
Self	Itself, populated from the created SearchConfigBinding.

RAISES	DESCRIPTION
ValueError	If object_id or search_configuration_id is not set.

Bind a SearchConfiguration to a Project.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfigBinding

syn = Synapse()
syn.login()

binding = SearchConfigBinding(
    object_id="syn12345",
    search_configuration_id="6789",
)
binding = binding.store()
print(f"Bound SearchConfiguration {binding.search_configuration_id} "
      f"to {binding.object_id}")

Source code in synapseclient/models/protocols/search_management_protocol.py

def store(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Bind ``search_configuration_id`` to the entity ``object_id``. Replaces
    any existing binding on that entity.

    Arguments:
        synapse_client: If not passed in and caching was not disabled by
            `Synapse.allow_client_caching(False)` this will use the last created
            instance from the Synapse class constructor.

    Returns:
        Itself, populated from the created SearchConfigBinding.

    Raises:
        ValueError: If ``object_id`` or ``search_configuration_id`` is not set.

    Example: Bind a SearchConfiguration to a Project.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfigBinding

        syn = Synapse()
        syn.login()

        binding = SearchConfigBinding(
            object_id="syn12345",
            search_configuration_id="6789",
        )
        binding = binding.store()
        print(f"Bound SearchConfiguration {binding.search_configuration_id} "
              f"to {binding.object_id}")
        ```
    """
    return self

get

get(*, synapse_client: Optional[Synapse] = None) -> Self

Get the effective binding for the entity object_id, resolved by walking up the entity hierarchy.

PARAMETER	DESCRIPTION
synapse_client	If not passed in and caching was not disabled by Synapse.allow_client_caching(False) this will use the last created instance from the Synapse class constructor. TYPE: Optional[Synapse] DEFAULT: None

RETURNS	DESCRIPTION
Self	Itself, populated from the resolved SearchConfigBinding.

RAISES	DESCRIPTION
ValueError	If object_id is not set.

Get the effective binding for a Project.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfigBinding

syn = Synapse()
syn.login()

binding = SearchConfigBinding(object_id="syn12345").get()
print(binding.search_configuration_id)

Source code in synapseclient/models/protocols/search_management_protocol.py

def get(self, *, synapse_client: Optional["Synapse"] = None) -> "Self":
    """Get the effective binding for the entity ``object_id``, resolved by
    walking up the entity hierarchy.

    Arguments:
        synapse_client: If not passed in and caching was not disabled by
            `Synapse.allow_client_caching(False)` this will use the last created
            instance from the Synapse class constructor.

    Returns:
        Itself, populated from the resolved SearchConfigBinding.

    Raises:
        ValueError: If ``object_id`` is not set.

    Example: Get the effective binding for a Project.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfigBinding

        syn = Synapse()
        syn.login()

        binding = SearchConfigBinding(object_id="syn12345").get()
        print(binding.search_configuration_id)
        ```
    """
    return self

delete

delete(*, synapse_client: Optional[Synapse] = None) -> None

Clear the binding on the entity object_id.

PARAMETER	DESCRIPTION
synapse_client	If not passed in and caching was not disabled by Synapse.allow_client_caching(False) this will use the last created instance from the Synapse class constructor. TYPE: Optional[Synapse] DEFAULT: None

RAISES	DESCRIPTION
ValueError	If object_id is not set.

Clear the binding on a Project.

 

from synapseclient import Synapse
from synapseclient.models import SearchConfigBinding

syn = Synapse()
syn.login()

SearchConfigBinding(object_id="syn12345").delete()

Source code in synapseclient/models/protocols/search_management_protocol.py

def delete(self, *, synapse_client: Optional["Synapse"] = None) -> None:
    """Clear the binding on the entity ``object_id``.

    Arguments:
        synapse_client: If not passed in and caching was not disabled by
            `Synapse.allow_client_caching(False)` this will use the last created
            instance from the Synapse class constructor.

    Raises:
        ValueError: If ``object_id`` is not set.

    Example: Clear the binding on a Project.
         

        ```python
        from synapseclient import Synapse
        from synapseclient.models import SearchConfigBinding

        syn = Synapse()
        syn.login()

        SearchConfigBinding(object_id="syn12345").delete()
        ```
    """
    return None

Supporting types

synapseclient.models.ColumnAnalyzerOverrideEntry dataclass

Assigns one TextAnalyzer to one column.

Represents a Synapse ColumnAnalyzerOverrideEntry.

Source code in synapseclient/models/search_management.py

@dataclass
class ColumnAnalyzerOverrideEntry:
    """Assigns one TextAnalyzer to one column.

    Represents a [Synapse ColumnAnalyzerOverrideEntry](https://rest-docs.synapse.org/rest/org/sagebionetworks/repo/model/search/table/ColumnAnalyzerOverrideEntry.html).
    """

    column_name: Optional[str] = None
    """The name of the column to override. Silently skipped at index-build time if the column is not present in the target SearchIndex's schema — a single override bundle can therefore be applied across several indexes that share some column names"""

    analyzer: Optional[Union[AnalyzerRef, Dict[str, Any]]] = None
    """The analyzer to use for this column. Either a reference to a saved
    TextAnalyzer written as `{"$ref": "{organizationName}-{name}"}` (see
    [AnalyzerRef][synapseclient.models.search_dsl.AnalyzerRef]), or an inline
    OpenSearch [`settings.analysis`](https://docs.opensearch.org/latest/analyzers/)
    block."""

    def fill_from_dict(self, data: Dict[str, Any]) -> "Self":
        self.column_name = data.get("columnName", None)
        self.analyzer = data.get("analyzer", None)
        return self

    def to_synapse_request(self) -> Dict[str, Any]:
        body = {
            "columnName": self.column_name,
            "analyzer": self.analyzer,
        }
        delete_none_keys(body)
        return body

Attributes

column_name class-attribute instance-attribute

column_name: Optional[str] = None

The name of the column to override. Silently skipped at index-build time if the column is not present in the target SearchIndex's schema — a single override bundle can therefore be applied across several indexes that share some column names

analyzer class-attribute instance-attribute

analyzer: Optional[Union[AnalyzerRef, Dict[str, Any]]] = None

The analyzer to use for this column. Either a reference to a saved TextAnalyzer written as {"$ref": "{organizationName}-{name}"} (see [AnalyzerRef][synapseclient.models.search_dsl.AnalyzerRef]), or an inline OpenSearch settings.analysis block.