Skip to content

Commit

Permalink
Highlighting: require_field_match set to true by default
Browse files Browse the repository at this point in the history 
The default `false` for `require_field_match` is a bit odd and confusing for users, given that field names get ignored by default and every field gets highlighted if it contains terms extracted out of the query, regardless of which fields were queries. Changed the default to `true`, it can always be changed per request.

Closes #10627
Closes #11067
  • Loading branch information
@javanna
javanna committed May 15, 2015
1 parent 9d71816 commit a843008
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 21 deletions.
10 changes: 10 additions & 0 deletions docs/reference/migration/migrate_2_0.asciidoc
View file
Expand Up @@ -591,8 +591,18 @@ from fielddata.
[float]
=== Highlighting

The default value for the `require_field_match` option is `true` rather than
`false`, meaning that the highlighters will take the fields that were queried
into account by default. That means for instance that highlighting any field
when querying the `_all` field will produce no highlighted snippets by default,
given that the match was on the `_all` field only. Querying the same fields
that need to be highlighted is the cleaner solution to get highlighted snippets
back. Otherwise `require_field_match` option can be set to `false` to ignore
field names completely when highlighting.

The postings highlighter doesn't support the `require_field_match` option
anymore, it will only highlight fields that were queried.

The `match` query with type set to `match_phrase_prefix` is not supported by the
postings highlighter. No highlighted snippets will be returned.

8 changes: 4 additions & 4 deletions docs/reference/search/request/highlighting.asciidoc
View file
Expand Up @@ -404,10 +404,10 @@ at the field level.
[[field-match]]
==== Require Field Match

`require_field_match` can be set to `true` which will cause a field to
be highlighted only if a query matched that field. `false` means that
terms are highlighted on all requested fields regardless if the query
matches specifically on them.
`require_field_match` can be set to `false` which will cause any field to
be highlighted regardless of whether the query matched specifically on them.
The default behaviour is `true`, meaning that only fields that hold a query
match will be highlighted.

[[boundary-characters]]
==== Boundary Characters
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/elasticsearch/search/highlight/HighlighterParseElement.java
View file
Expand Up @@ -82,7 +82,7 @@ public SearchContextHighlight parse(XContentParser parser, IndexQueryParserServi

final SearchContextHighlight.FieldOptions.Builder globalOptionsBuilder = new SearchContextHighlight.FieldOptions.Builder()
.preTags(DEFAULT_PRE_TAGS).postTags(DEFAULT_POST_TAGS).scoreOrdered(false).highlightFilter(false)
.requireFieldMatch(false).forceSource(false).fragmentCharSize(100).numberOfFragments(5)
.requireFieldMatch(true).forceSource(false).fragmentCharSize(100).numberOfFragments(5)
.encoder("default").boundaryMaxScan(SimpleBoundaryScanner.DEFAULT_MAX_SCAN)
.boundaryChars(SimpleBoundaryScanner.DEFAULT_BOUNDARY_CHARS)
.noMatchSize(0).phraseLimit(256);
Expand Down
32 changes: 16 additions & 16 deletions src/test/java/org/elasticsearch/search/highlight/HighlighterSearchTests.java
View file
Expand Up @@ -458,7 +458,7 @@ public void testHighlightIssue1994() throws Exception {
SearchResponse search = client().prepareSearch()
.setQuery(matchQuery("title", "bug"))
.addHighlightedField("title", -1, 2)
.addHighlightedField("titleTV", -1, 2)
.addHighlightedField("titleTV", -1, 2).setHighlighterRequireFieldMatch(false)
.get();

assertHighlight(search, 0, "title", 0, equalTo("This is a test on the highlighting <em>bug</em> present in elasticsearch"));
Expand Down Expand Up @@ -490,7 +490,7 @@ public void testGlobalHighlightingSettingsOverriddenAtFieldLevel() {
.query(termQuery("field1", "test"))
.highlight(highlight().order("score").preTags("<global>").postTags("</global>").fragmentSize(1).numOfFragments(1)
.field(new HighlightBuilder.Field("field1").numOfFragments(2))
.field(new HighlightBuilder.Field("field2").preTags("<field2>").postTags("</field2>").fragmentSize(50)));
.field(new HighlightBuilder.Field("field2").preTags("<field2>").postTags("</field2>").fragmentSize(50).requireFieldMatch(false)));

SearchResponse searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand Down Expand Up @@ -603,7 +603,7 @@ public void testPlainHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field1");
source = searchSource()
.query(termQuery("_all", "test"))
.highlight(highlight().field("field1").order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field1").order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -612,7 +612,7 @@ public void testPlainHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field2");
source = searchSource()
.query(termQuery("_all", "quick"))
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -621,7 +621,7 @@ public void testPlainHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field2");
source = searchSource()
.query(prefixQuery("_all", "qui"))
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -630,7 +630,7 @@ public void testPlainHighlighter() throws Exception {
logger.info("--> searching on _all with constant score, highlighting on field2");
source = searchSource()
.query(constantScoreQuery(prefixQuery("_all", "qui")))
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -639,7 +639,7 @@ public void testPlainHighlighter() throws Exception {
logger.info("--> searching on _all with constant score, highlighting on field2");
source = searchSource()
.query(boolQuery().should(constantScoreQuery(prefixQuery("_all", "qui"))))
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();
assertHighlight(searchResponse, 0, "field2", 0, 1, equalTo("The <xxx>quick</xxx> brown fox jumps over the lazy dog"));
Expand All @@ -666,7 +666,7 @@ public void testFastVectorHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field1");
source = searchSource()
.query(termQuery("_all", "test"))
.highlight(highlight().field("field1", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field1", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -676,7 +676,7 @@ public void testFastVectorHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field2");
source = searchSource()
.query(termQuery("_all", "quick"))
.highlight(highlight().field("field2", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand All @@ -686,7 +686,7 @@ public void testFastVectorHighlighter() throws Exception {
logger.info("--> searching on _all, highlighting on field2");
source = searchSource()
.query(prefixQuery("_all", "qui"))
.highlight(highlight().field("field2", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>"));
.highlight(highlight().field("field2", 100, 0).order("score").preTags("<xxx>").postTags("</xxx>").requireFieldMatch(false));

searchResponse = client().prepareSearch("test").setSource(source.buildAsBytes()).get();

Expand Down Expand Up @@ -1877,7 +1877,7 @@ public void testPostingsHighlighter() throws Exception {

assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("this is a <xxx>test</xxx>"));

logger.info("--> searching on _all, highlighting on field1");
logger.info("--> searching on field1, highlighting on field1");
source = searchSource()
.query(termQuery("field1", "test"))
.highlight(highlight().field("field1").preTags("<xxx>").postTags("</xxx>"));
Expand All @@ -1886,7 +1886,7 @@ public void testPostingsHighlighter() throws Exception {

assertHighlight(searchResponse, 0, "field1", 0, 1, equalTo("this is a <xxx>test</xxx>"));

logger.info("--> searching on _all, highlighting on field2");
logger.info("--> searching on field2, highlighting on field2");
source = searchSource()
.query(termQuery("field2", "quick"))
.highlight(highlight().field("field2").order("score").preTags("<xxx>").postTags("</xxx>"));
Expand All @@ -1895,7 +1895,7 @@ public void testPostingsHighlighter() throws Exception {

assertHighlight(searchResponse, 0, "field2", 0, 1, equalTo("The <xxx>quick</xxx> brown fox jumps over the lazy <xxx>quick</xxx> dog"));

logger.info("--> searching on _all, highlighting on field2");
logger.info("--> searching on field2, highlighting on field2");
source = searchSource()
.query(matchPhraseQuery("field2", "quick brown"))
.highlight(highlight().field("field2").preTags("<xxx>").postTags("</xxx>"));
Expand All @@ -1906,10 +1906,10 @@ public void testPostingsHighlighter() throws Exception {
assertHighlight(searchResponse, 0, "field2", 0, 1, equalTo("The <xxx>quick</xxx> <xxx>brown</xxx> fox jumps over the lazy <xxx>quick</xxx> dog"));

//lets fall back to the standard highlighter then, what people would do to highlight query matches
logger.info("--> searching on _all, highlighting on field2, falling back to the plain highlighter");
logger.info("--> searching on field2, highlighting on field2, falling back to the plain highlighter");
source = searchSource()
.query(matchPhraseQuery("field2", "quick brown"))
.highlight(highlight().field("field2").preTags("<xxx>").postTags("</xxx>").highlighterType("highlighter"));
.query(matchPhraseQuery("_all", "quick brown"))
.highlight(highlight().field("field2").preTags("<xxx>").postTags("</xxx>").highlighterType("highlighter").requireFieldMatch(false));

searchResponse = client().search(searchRequest("test").source(source)).actionGet();

Expand Down

0 comments on commit a843008

Please sign in to comment.