Contexts

A context is a set of settings that can be resolved from a search request. It is recommended that the contexts are managed via the Admin UI, but they can be set up via the Admin API. See the full API reference here.

A context consists of:

• Context id is used to uniquely identify the context.
• Name assigns an easy-to-read name to the context.
• Context conditions are used to resolve the correct context when searching.
• Context partitions define the partition weights for the context.
• Search relevance weights are used to calculate the relevance of products given a search phrase.
• Context facets are used to specify the facets which are returned when searching.
• Context pins are used to specify results that should be promoted to the top of the result when searching.

Contexts are related to commercial sorting. Contexts allow for different sorting configurations for different scenarios. High-end designer products might benefit from boosting exclusivity, while products that targets the general audience might boost on number of clicks last 3 days, or number of sales last 30 days.

Without contexts, all products would have the same boost, all the time. But with contexts, search requests with a specific brand filter, and other conditions, may sort by different parameters, providing tight control over the user's search and browse experience.

Context preview

The UI has a context preview page, where the context can be edited, and it is possible to see the effect, different settings have on which products are returned.

Context conditions

Context conditions are used to specify which context will be used. The more context conditions that match data in the search request, the more relevant the context is. The most relevant context which has all context conditions satisfied is used.

graph TD;
    _f[fallback

Fallback]
    _f --> _browse[context_browse

Scope = Browse]
    _f --> _search[context_search

Scope = FullSearch]
    _browse --> _cat[context_clothing

Category = Clothing]
    _cat --> _red[Color = Red] --> _size[context_red_xl

Size = xl]
    _cat --> _yel[context_yellow

Color = Yellow]

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
    "segmentId": "b2c-en-test",
    "scopeId": "browse",
    "filters": {
        "CategoryNames": {
            "values": [
                "Clothing"
            ],
            "match": "any"
        },
        "color": {
            "values": [
                "red"
            ],
            "match": "any"
        },
        "size": {
            "values": [
                "xl"
            ],
            "match": "any"
        }
    },
    "phrase": ""
}

The contexts conditions that can be used are:

• Attributes
• Split tests
• Scopes
• Categories
• If the search request contains a phrase

Fallback context

Each segment must have a fallback context which is used if no other matching context can be found. The fallback context cannot have any context conditions or be inactive, but otherwise behaves as other contexts. Each segment must have exactly one fallback context, if not, a conflict occurs in the publication.

Context partitions

Context partitions are used to control the sorting of products. A partition is multiplied by a weight and added to a context to create a context partition. See commercial properties for more information.

An example of two context partitions could be: Products that are in the 10% most sold products have a weight of 10, and products that are in stock have a weight of 5. Different contexts can have different partitions. This means that while one context might boost products that are in the 10% most sold products, another context might boost products that are trending.

Personalization weight is used to specify how much a person’s affinity for the product should count in the score.

The sort order of the products will update live as changes are made to the weights, allowing for an experimental approach.

Search relevance

Search relevance is used to configure how important a phrase match is compared to other contributions. Often, a match in the name or short description of a product is more important than a match in long description. Also, a match on the product number is often the most important. A context is created with a set of recommended settings.

It is possible to choose the following weights:

• Very High
• High
• Medium
• Low

Only fields that have been configured as searchable can be assigned a search relevance.

While editing a context, a search will show how much it boosts every product, and changes to the Search relevance will affect the live preview immediately.

Context facets

Context facets are used to set up which facets should be returned in a search response, if the search request resolves into the context.

Each context can have one facet for each allowed filter. When selecting a context facet, the match type is specified. The order of the facets when editing a context reflects the order of facets in search responses.

Context pinning

Pinning bypasses commercial sorting within a context.

If a search request is sent with pinned ids, these will take priority over saved ids on the context.

Each context can have up to 200 pinned products/SKU's.

Context affinity weights

Context affinity weights describe how user affinities are boosted in search requests.

Each context can have unique boost values per affinity source.

Publication

Changes to a context will only take effect after publication. Only active contexts will be part of the publication.