Result information for relevance ranking modules
In addition to the basic reporting properties that are common to
each
DGraph.WhyRank property, there are also optional reporting
properties that may be included in
DGraph.WhyRank depending on the relevance ranking module.
The basic reporting properties in
DGraph.WhyRank that are common to all relevance
ranking modules include:
evaluationTime - the
time spent evaluating this relevance ranking module.
stratumRank - a value
indexating which stratum a record is placed in.
stratumDesc - the
description of the relevance ranking module (often, the name of the module, or
a description of options for the module).
The following table lists the optional reporting properties that are
specific to each relevance ranking module.
|
Relevance Rank Module Name
|
Additional DGraph.WhyRank Properties
|
|---|
|
Exact
|
rankedField - field name for
the highest ranked exact or subphrase match described in
stratumDesc.
|
|
Field
|
rankedField - field name for
the highest ranked field match.
|
|
First
|
rankedField - field name of
the highest ranked field described in
stratumDesc.
|
|
Freq
|
perFieldCount -
field-by-field count of occurrences in the format "<X1> in
<field1-name>, <X2> in <field2-name>, ...".
|
|
Glom
|
None.
|
|
Interp
|
rankedField - field name of
the highest ranked field described in
stratumDesc.
|
|
MaxFields
|
rankedField - field name of
the highest ranked field described in
stratumDesc.
|
|
NTerms
|
None.
|
|
NumFields
|
fieldsMatched - if
considerFieldRanks is enabled for the module,
then
fieldsMatched is a comma-separated list of:
<field-name> + "(" + <field-rank> + ")". Otherwise,
fieldsMatched is a comma-separated list of the
field names that matched.
|
|
Phrase
|
rankedField - field name of
the highest ranked field (if a phrase match).
|
|
Proximity
|
rankedField - field name of
the highest ranked field (if a field match).
|
|
Spell
|
rankedField - field name of
a field match that is not a spell corrected match.
|
|
Static
|
fieldCompared - name
of field sorted by. If there are multiple fields, names are pipe '|' delimited.
directionCompared -
direction ("ascending" or "descending") of the sort. If there are multiple
fields, directions are pipe '|' delimited
fieldType -
corresponding field type ("integer", "dimension", "string", etc). If there are
multiple fields, types are '|' delimited.
NoteThe Static module does not return either the
evaluationTime or the
stratumRank properties.
|
|
Stratify
|
None.
|
|
Stem
|
rankedField - field name of a field match that
is not a stemmed match.
|
|
Thesaurus
|
rankedField - field name of
a field match that is not a thesaurus match
|
|
WeightedFreq
|
None.
|
