Text Tagger Stage

Configuration

This stage uses the SolrTextTagger handler to identify known entities in the query by searching the _query_rewrite collection (or the _query_rewrite_staging collection in the case of the Fusion AI query rewriting Simulator) to find matching spelling corrections, phrase boosts, underperforming query improvements, and synonym expansions in order to perform query rewriting.

When the query rewrite entails boosting, the boosting is applied later in the pipeline, during the Solr Query stage.

Note	Although this stage is available without a Fusion AI license, it is only effective after running Fusion AI jobs or creating Fusion AI rules. See Query Rewriting for details.

Configuration

Tip	When entering configuration values in the UI, use unescaped characters, such as `\t` for the tab character. When entering configuration values in the API, use escaped characters, such as `\\t` for the tab character.

When using Fusion's REST API, the type for this stage is: text-tagger.

Property Description, Type

filterOverride

Filter Override

Use this option to override filtering for built-in tagger doc types with your own filter.

type: string

overlaps

Overlapping Tag Policy

Choose the algorithm to determine which tags in an overlapping set should be retained, versus being pruned away. Options are: ALL, NO_SUB, LONGEST_DOMINANT_RIGHT; defaults to ALL

type: string

default value: 'ALL'

enum: { ALL NO_SUB LONGEST_DOMINANT_RIGHT }

paramToTag

Param to Tag

Name of the parameter in the request containing text to tag, defaults to 'q'

type: string

default value: 'q'

params

Additional Params to be Included in the Text Tagger Request.

type: array of object

object attributes: {
  key (required) : {
    display name: Parameter Name
    type: string
    }
  value : {
    display name: Parameter Value
    type: string
    }
  }

phraseBoost

Default Phrase Boost

Default boost to be applied to phrases that don't have a boost set; set to -1 to disable this behavior.

type: number

default value: '2.0'

phraseSlop

Default Phrase Slop

Default phrase slop to be applied to detected phrases.

type: integer

default value: '10'

phrase_boosting_enabled

Phrase Boosting

If checked, then this stage will perform phrase boosting on the incoming query.

type: boolean

default value: 'true'

saveTagsInContextKey

Save Tags in Context

Save tags in context instead of applying directly to the incoming query in this stage; allows downstream stages to apply the tags after doing other processing.

type: string

spell_corrections_enabled

Spell Correction

If checked, then this stage will perform spell corrections on the incoming query.

type: boolean

default value: 'true'

synonymExpansionBoost

Original Term Boost for Synonyms

Boost applied to the original term when doing synonym expansion; set to -1 to disable this behavior.

type: number

default value: '2.0'

synonym_expansion_enabled

Synonym Expansion

If checked, then this stage will perform synonym expansion on the incoming query.

type: boolean

default value: 'true'

taggedOutputParam

Tagged Output Param

Apply the matching tags to the 'paramToTag' value and set the parameter specified by this option; defaults to the value of the 'paramToTag' setting.

type: string

taggerCollectionId

Tagger Collection

Collection to send the tagger request to; defaults to the query_rewrite collection for the application in context.

type: string

minLength: 1

tail_rewrites_enabled

Tail Rewrites

If checked, then this stage will perform tail rewrites on teh incoming query.

type: boolean

default value: 'true'

useEmbeddedSolrServer

Use Embedded Solr

If checked, then this stage will load the remote tagger collection into an embedded Solr to perform the lookup in memory. Only use this option if the tagger collection fits in the memory available to the Fusion API service.

type: boolean

default value: 'false'