forked from elastic/elasticsearch
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Based on PR elastic#45, we add a new language detection option using Language detection feature available in Tika: https://tika.apache.org/1.4/detection.html#Language_Detection By default, language detection is disabled (`false`) as it could come with a cost. This default value can be changed by setting the `index.mapping.attachment.detect_language` setting. It can also be provided on a per document indexed using the `_detect_language` parameter. Closes elastic#45. Closes elastic#44.
- Loading branch information
1 parent
621995d
commit 3d15cb0
Showing
7 changed files
with
225 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
.../java/org/elasticsearch/index/mapper/xcontent/LanguageDetectionAttachmentMapperTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * Licensed to ElasticSearch and Shay Banon under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. ElasticSearch licenses this | ||
| * file to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.index.mapper.xcontent; | ||
|
|
||
| import org.elasticsearch.common.settings.ImmutableSettings; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.index.Index; | ||
| import org.elasticsearch.index.analysis.AnalysisService; | ||
| import org.elasticsearch.index.mapper.DocumentMapper; | ||
| import org.elasticsearch.index.mapper.DocumentMapperParser; | ||
| import org.elasticsearch.index.mapper.ParseContext; | ||
| import org.elasticsearch.index.mapper.attachment.AttachmentMapper; | ||
| import org.elasticsearch.index.mapper.core.StringFieldMapper; | ||
| import org.elasticsearch.test.ElasticsearchTestCase; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import static org.elasticsearch.common.io.Streams.copyToBytesFromClasspath; | ||
| import static org.elasticsearch.common.io.Streams.copyToStringFromClasspath; | ||
| import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; | ||
| import static org.hamcrest.Matchers.equalTo; | ||
| import static org.hamcrest.Matchers.instanceOf; | ||
|
|
||
| /** | ||
| * | ||
| */ | ||
| public class LanguageDetectionAttachmentMapperTests extends ElasticsearchTestCase { | ||
|
|
||
| private DocumentMapper docMapper; | ||
|
|
||
| @Before | ||
| public void setupMapperParser() throws IOException { | ||
| setupMapperParser(true); | ||
| } | ||
|
|
||
| public void setupMapperParser(boolean langDetect) throws IOException { | ||
| DocumentMapperParser mapperParser = new DocumentMapperParser(new Index("test"), | ||
| ImmutableSettings.settingsBuilder().put("index.mapping.attachment.detect_language", langDetect).build(), | ||
| new AnalysisService(new Index("test")), null, null, null); | ||
| mapperParser.putTypeParser(AttachmentMapper.CONTENT_TYPE, new AttachmentMapper.TypeParser()); | ||
| String mapping = copyToStringFromClasspath("/org/elasticsearch/index/mapper/language/language-mapping.json"); | ||
| docMapper = mapperParser.parse(mapping); | ||
|
|
||
| assertThat(docMapper.mappers().fullName("file.language").mapper(), instanceOf(StringFieldMapper.class)); | ||
| } | ||
|
|
||
| private void testLanguage(String filename, String expected, String... forcedLanguage) throws IOException { | ||
| byte[] html = copyToBytesFromClasspath("/org/elasticsearch/index/mapper/xcontent/" + filename); | ||
|
|
||
| XContentBuilder xcb = jsonBuilder() | ||
| .startObject() | ||
| .field("_id", 1) | ||
| .startObject("file") | ||
| .field("_name", filename) | ||
| .field("content", html); | ||
|
|
||
| if (forcedLanguage.length > 0) { | ||
| xcb.field("language", forcedLanguage[0]); | ||
| } | ||
|
|
||
| xcb.endObject().endObject(); | ||
|
|
||
| ParseContext.Document doc = docMapper.parse(xcb.bytes()).rootDoc(); | ||
|
|
||
| // Our mapping should be kept as a String | ||
| assertThat(doc.get(docMapper.mappers().smartName("file.language").mapper().names().indexName()), equalTo(expected)); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFrDetection() throws Exception { | ||
| testLanguage("text-in-french.txt", "fr"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testEnDetection() throws Exception { | ||
| testLanguage("text-in-english.txt", "en"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFrForced() throws Exception { | ||
| testLanguage("text-in-english.txt", "fr", "fr"); | ||
| } | ||
|
|
||
| /** | ||
| * This test gives strange results! detection of ":-)" gives "lt" as a result | ||
| * @throws Exception | ||
| */ | ||
| @Test | ||
| public void testNoLanguage() throws Exception { | ||
| testLanguage("text-in-nolang.txt", "lt"); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLangDetectDisabled() throws Exception { | ||
| // We replace the mapper with another one which have index.mapping.attachment.detect_language = false | ||
| setupMapperParser(false); | ||
| testLanguage("text-in-english.txt", null); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLangDetectDocumentEnabled() throws Exception { | ||
| // We replace the mapper with another one which have index.mapping.attachment.detect_language = false | ||
| setupMapperParser(false); | ||
|
|
||
| byte[] html = copyToBytesFromClasspath("/org/elasticsearch/index/mapper/xcontent/text-in-english.txt"); | ||
|
|
||
| XContentBuilder xcb = jsonBuilder() | ||
| .startObject() | ||
| .field("_id", 1) | ||
| .startObject("file") | ||
| .field("_name", "text-in-english.txt") | ||
| .field("content", html) | ||
| .field("_detect_language", true) | ||
| .endObject().endObject(); | ||
|
|
||
| ParseContext.Document doc = docMapper.parse(xcb.bytes()).rootDoc(); | ||
|
|
||
| // Our mapping should be kept as a String | ||
| assertThat(doc.get(docMapper.mappers().smartName("file.language").mapper().names().indexName()), equalTo("en")); | ||
| } | ||
| } |
13 changes: 13 additions & 0 deletions
13
src/test/resources/org/elasticsearch/index/mapper/language/language-mapping.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "person": { | ||
| "properties": { | ||
| "file": { | ||
| "type": "attachment", | ||
| "path": "full", | ||
| "fields": { | ||
| "language": { "type": "string" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
1 change: 1 addition & 0 deletions
1
src/test/resources/org/elasticsearch/index/mapper/xcontent/text-in-english.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| "God Save the Queen" (alternatively "God Save the King" |
1 change: 1 addition & 0 deletions
1
src/test/resources/org/elasticsearch/index/mapper/xcontent/text-in-french.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Allons enfants de la Patrie Le jour de gloire est arrivé. Contre nous de la tyrannie |
Empty file.