Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Simple Types - indexHighlighterType

  • Article
  • 1 minutes to read

Description

Selects the Elasticsearch highlighter type used to produce highlighted fragments.

    'plain' (default) is the Elasticsearch plain highlighter. It re-analyzes the field at query time and produces fragments
    of fixed character length. Fragment boundaries do not respect word, sentence or markup boundaries, so a fragment can
    begin or end partway through any expression.

    'unified' is the Elasticsearch unified highlighter. Fragment boundaries are sentence-aware (sentence boundary detection)
    so fragments are much more likely to begin and end at natural sentence breaks. The configured highlightLength is treated
    as a target rather than a hard cap. Works on any text field; performs best when the field has 'offsets' index_options
    configured, otherwise the field is re-analyzed at query time.

    'fvh' is the Elasticsearch Fast Vector Highlighter. Fastest on large documents with many matches but requires the
    target field to have 'term_vector: with_positions_offsets' set in its mapping at index time. Will error at query time
    if used against a field without that mapping. Most current ESP indices do NOT have term vectors enabled.

Value Constraints

Only the following values are permitted for this type, passing any other value will generate a validation error.

Allowed Value Mapped Value Description
plain 0 No description provided
unified 1 No description provided
fvh 2 No description provided
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document