Promoting Hits

Promoting a single item

Use Case

A book store wants to recommend a Harry Potter Box Set whenever the words Harry Potter form part of a search.

Rule

If query=Harry Potter then promote Harry Potter Box Set

API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// turn json into an array
$rule = array(
  'objectID' => 'promote-harry-potter-box-set',
  'condition' => array(
    'pattern' => 'Harry Potter',
    'anchoring' => 'contains'
  ),
  'consequence' => array(
    'promote' => array(
        'objectID' => 'HP-12345',
        'position': 0 // objectID 'HP-12345' ==> Harry Potter Box Set
    )
  )
);

// push rule to index
$index->saveRule($rule);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
var rule = new Rule
{
  ObjectID = "Promote Harry Potter Box Set",
  Condition = new Condition { Anchoring = "contains", Pattern = "Harry Potter" },
  Consequence = new Consequence
  {
    Promote = new List<ConsequencePromote> 
    {
      new ConsequencePromote 
      { 
        ObjectID = "HP-12345",
        Position = 0
      }
    }
  }
};

index.SaveRule(rule);

// Asynchronous
await index.SaveRuleAsync(rule);

1
2
3
4
5
6
7
8
9
10
11
Condition condition = new Condition().setPattern("Harry Potter").setAnchoring("contains");
ConsequencePromote promote = new ConsequencePromote().setObjectID("HP-12345").setPosition(0);
Consequence consequence = new Consequence().setPromote(Collections.singletonList(promote));

Rule rule =
        new Rule()
                .setObjectID("Promote Harry Potter Box Set")
                .setCondition(condition)
                .setConsequence(consequence);

index.saveRule(rule);

1
2
3
4
5
6
7
8
9
10
11
rule := search.Rule{
	ObjectID:  "promote-harry-potter-box-set",
	Condition: search.RuleCondition{Anchoring: search.Contains, Pattern: "Harry Potter"},
	Consequence: search.RuleConsequence{
		Promote: []search.PromotedObject{
			{"HP-12345", 0}, // objectID 'HP-12345' ==> Harry Potter Box Set
		},
	},
}

res, err := index.SaveRule(rule, false)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
val rule = Rule(
  objectID = "promote-harry-potter-box-set",
  condition = Condition(
    anchoring = "contains",
    pattern = "Harry Potter",
  ),
  consequence = Consequence(
    promote = Some(Seq(ConsequencePromote("HP-12345", 0))),
  )
)

client.execute {
  save rule rule inIndex "indexName"
}

1
2
3
4
5
6
7
8
9
val rules = rules {
    rule(
        "Promote Harry Potter Box Set",
        Condition(Contains, Literal("Harry Potter")),
        Consequence(promote = promotions { +ObjectID("HP-12345")(0) })
    )
}

index.saveRules(rules)

Dashboard

Promoting the newest release

Use Case

You’ve placed “best-selling items” at the top of your search results by using Custom Ranking. But the newest release? Set up a rule telling the engine that whenever iPhone is searched for, place the newest version at the top, but for the rest of the same brand phones, continue sorting by most-sold.

Rule

If query = iphone then promote newest iphone release

API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// turn json into an array
$rule = array(
  'objectID' => 'Promote iPhone X',
  'condition' => array(
    'pattern' => 'iPhone',
    'anchoring' => 'contains'
  ),
  'consequence' => array(
    'promote' => array(
      'objectID' => 'iPhone-12345',
      'position' => 0 // objectID 'iPhone-12345' ==> iPhone X (newest release)
    )
  )
);

// push rule to index
$index->saveRule($rule);

Dashboard

Promoting some results over others

Note: This only applies to Enterprise plans.

Use Case

Tomato: A simple search, but one that may never return the fruit (or vegetable) because too many Tomato Soup brands are selling better than cherry tomatoes.

Rule

If query=tomato then put fruits higher than the rest

API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// turn json into an array
$rule = array(
  'objectID' => 'tomato fruit',
  'condition' => array(
    'pattern' => 'tomato',
    'anchoring' => 'contains'
  ),
  'consequence' => array(
    'optionalFilters' => 'food_group:fruit'
  )
);

// push rule to index
$index->saveRule($rule);

Dashboard