afs:explain - AFS

AFS Integration Guide

Product
AFS
AFS_Version
7.9
Category
Reference Guide

Role

Requests the inclusion of additional information in the output feed in order to tune or understand the behavior of the search engine. The available options are:

  • afs:explain=env adds a dump of the Unix environment of the search engine.
  • afs:explain=cluster, afs:explain=from, afs:explain=where and afs:explain=select add a dump of the abstract syntax representing the parsing of the CLUSTER,FROM, WHERE and SELECT clause respectively.
  • afs:explain=permalink includes the search URI in the output feed.
  • afs:explain=relevance includes the relevance information in the output feed (afs:relevance elements).
  • afs:explain=wildcard includes information about the expansions that have been found for the wildcard query.

Status

Optional. It can be set several times, in which case the information from every value is included in the output feed.

Example

afs:explain=where

Output example for "afs:query=he*&afs:explain=wildcard":

<afs:meta uri="search tool" totalItems="6" totalItemsIsExact="true" pageItems="6" firstPageItem="1" lastPageItem="6" durationMs="-1" firstPaFId="1" lastPaFId="1" producer="search">
<afs:wildcardExpansions>
<afs:wildcard prefix="he">
<afs:expansions keyword="helene" occurences="6"/>
<afs:expansions keyword="henriette" occurences="5"/>
<afs:expansions keyword="herve" occurences="5"/>
</afs:wildcard>
</afs:wildcardExpansions>
</afs:meta>