Block Documents Stage

The Block Documents query pipeline stage removes documents from the result based on a Block Documents rule which consists of the following elements:

  • field - the document field to filter on.

  • keywords - the words, phrases, or regex used as the filter.

  • mode - filtering logic applied to keywords, one of:

    • exact - exact matching on any item in the keywords list.

    • phrase - phrase matching on the items in the keywords list.

    • regex - treat items in the keywords list as a regex.

    • match - requires a match for every item in the keyword list, but doesn’t require phrase matching.

  • blocks - a list of document IDs for documents which are always removed from the query result.

The block documents rule is used to craft a Solr query. The keywords are added to the q Solr query parameter, by default. The configuration property queryParam can be used to specify a different Solr query parameter to use as the keywords filter. The rest of the rule is processed into the fq Solr query parameter.