API Reference / API Parameters / separatorsToIndex

separatorsToIndex

Type: string
Engine default: "" (separators are not indexed)
Parameter syntax
'separatorsToIndex' => 'separators'

Can be used in these methods:

About this parameter

Control which separators are indexed.

Separators are all non-alphanumeric characters except space.

Usage notes:

  • By default, separators are not indexed.

  • Here is a non-exhaustive list of separators frequently used by our customers:
    !#()[]{}*+-_一,:;<>?@/\^|%&~£¥$§€`"'‘’“”†‡
  • The search API treats separator characters as separate words. If you search “Google+” for example, the search API considers “Google” and “+” as two separate words, and counts as a match on two words in getRankingInfo.

Examples

Set list separators to index

To be able to search for “Google+” or “C#”, we define + and # as separatorsToIndex.

1
2
3
$index->setSettings([
  'separatorsToIndex' => '+#'
]);

Did you find this page helpful?