The Open API specification for Synapse is now available for download!

Download Open API Spec

NamedSearchPipeline

org.sagebionetworks.repo.model.search.table.NamedSearchPipeline

A shareable, named search pipeline: how a hybrid query's per-clause scores are normalized and combined. NamedSearchPipelines belong to an Organization and are identified by the qualified name {organizationName}-{name}.

Example:

{
  "organizationName": "biomed",
  "name": "keyword_heavy",
  "settings": {
    "phase_results_processors": [
      {
        "normalization-processor": {
          "normalization": { "technique": "min_max" },
          "combination": {
            "technique": "arithmetic_mean",
            "parameters": { "weights": [0.4, 0.3, 0.1, 0.1, 0.1] }
          }
        }
      }
    ]
  }
}

Field Type Description
id STRING The unique ID of this search pipeline.
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 search pipeline.
settings SearchPipeline

A search pipeline: how a hybrid query's per-clause scores are normalized and combined. Saved as the settings of a NamedSearchPipeline.

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.