Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Not yet released

...


Important notice:

The tmhits filter and sort options are only available if the tmhitsEnabled property is true in the rights properties. Until end of 2018, this will be the case for all customers.


Default values:

All properties below are optional.

...

ctxboost

Optional. Specifies to what extent a matching context promotes a hit in the search results.

  • 0: Disabled. The search results disregard whether the context matches or not.
  • 1: Minimal promotion. Makes sure that the top results contain good hits that also match the context
  • ...
  • 5: Maximal promotion. This will give high importance to hits with the same context, even if text similarity is not so high.

With this setting you can give additional boost to hits that have the same context value as the segment being searched. The context of a segment typically contains formatting information such as "Heading 1", "Hyperlink" etc. or, when localizing software, string IDs or keys. Specifically with software localization this setting should be increased.

Code Block
"ctxboost": 1


int?

Optional

filters

Optional array of filters on various properties such as status, bookmarks, context, change date and so on. Example:

Code Block
"filters": [
   { "field": "st", "values": [ 1 ] },
   { "field": "bk", "values": [ 1, 2 ] }
]

See below.

object[]?

Optional

...