honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removing request parameters in _analyze API 

Remove request params in _analyze API without index param
Change rest-api-test using JSON
Change docs using JSON

Closes #20246
This commit is contained in:
Jun Ohtani 2016-09-22 20:54:30 +09:00
parent 5d38248afa
commit 370f0b885e
16 changed files with 144 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
core/src/main/java/org/elasticsearch/rest/action/admin/indices/RestAnalyzeAction.java
View File

@ -67,42 +67,14 @@ public class RestAnalyzeAction extends BaseRestHandler {
@Override
public RestChannelConsumer prepareRequest(final RestRequest request, final NodeClient client) throws IOException {
String[] texts = request.paramAsStringArrayOrEmptyIfAll("text");
AnalyzeRequest analyzeRequest = new AnalyzeRequest(request.param("index"));
analyzeRequest.text(texts);
analyzeRequest.analyzer(request.param("analyzer"));
analyzeRequest.field(request.param("field"));
final String tokenizer = request.param("tokenizer");
if (tokenizer != null) {
analyzeRequest.tokenizer(tokenizer);
}
for (String filter : request.paramAsStringArray("filter", Strings.EMPTY_ARRAY)) {
analyzeRequest.addTokenFilter(filter);
}
for (String charFilter : request.paramAsStringArray("char_filter", Strings.EMPTY_ARRAY)) {
analyzeRequest.addTokenFilter(charFilter);
}
analyzeRequest.explain(request.paramAsBoolean("explain", false));
analyzeRequest.attributes(request.paramAsStringArray("attributes", analyzeRequest.attributes()));
if (RestActions.hasBodyContent(request)) {
XContentType type = RestActions.guessBodyContentType(request);
if (type == null) {
if (texts == null || texts.length == 0) {
texts = new String[]{ RestActions.getRestContent(request).utf8ToString() };
analyzeRequest.text(texts);
}
} else {
// NOTE: if rest request with xcontent body has request parameters, the parameters does not override xcontent values
buildFromContent(RestActions.getRestContent(request), analyzeRequest, parseFieldMatcher);
}
}
return channel -> client.admin().indices().analyze(analyzeRequest, new RestToXContentListener<>(channel));
}
public static void buildFromContent(BytesReference content, AnalyzeRequest analyzeRequest, ParseFieldMatcher parseFieldMatcher) {
static void buildFromContent(BytesReference content, AnalyzeRequest analyzeRequest, ParseFieldMatcher parseFieldMatcher) {
try (XContentParser parser = XContentHelper.createParser(content)) {
if (parser.nextToken() != XContentParser.Token.START_OBJECT) {
throw new IllegalArgumentException("Malformed content, must start with an object");

12
core/src/test/java/org/elasticsearch/rest/action/admin/indices/RestAnalyzeActionTests.java
View File

@ -19,16 +19,25 @@
package org.elasticsearch.rest.action.admin.indices;
import org.elasticsearch.action.admin.indices.analyze.AnalyzeRequest;
import org.elasticsearch.client.node.NodeClient;
import org.elasticsearch.common.ParseFieldMatcher;
import org.elasticsearch.common.bytes.BytesArray;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.xcontent.XContentFactory;
import org.elasticsearch.rest.RestChannel;
import org.elasticsearch.rest.RestRequest;
import org.elasticsearch.test.ESTestCase;
import org.elasticsearch.test.rest.FakeRestRequest;
import java.util.HashMap;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.notNullValue;
import static org.hamcrest.Matchers.startsWith;
import static org.mockito.Mockito.doCallRealMethod;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
public class RestAnalyzeActionTests extends ESTestCase {
@ -118,7 +127,7 @@ public class RestAnalyzeActionTests extends ESTestCase {
assertThat(e.getMessage(), startsWith("explain must be either 'true' or 'false'"));
}
public void testDeprecatedParamException() throws Exception {
public void testDeprecatedParamIn2xException() throws Exception {
IllegalArgumentException e = expectThrows(IllegalArgumentException.class,
() -> RestAnalyzeAction.buildFromContent(
XContentFactory.jsonBuilder()
@ -165,5 +174,4 @@ public class RestAnalyzeActionTests extends ESTestCase {
, new AnalyzeRequest("for test"), new ParseFieldMatcher(Settings.EMPTY)));
assertThat(e.getMessage(), startsWith("Unknown parameter [token_filter]"));
}
}

15
docs/plugins/analysis-icu.asciidoc
View File

@ -164,7 +164,11 @@ PUT icu_sample
}
}
POST icu_sample/_analyze?analyzer=my_analyzer&text=Elasticsearch. Wow!
POST icu_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "Elasticsearch. Wow!"
}
--------------------------------------------------
// CONSOLE
@ -480,18 +484,21 @@ PUT icu_sample
}
}
GET icu_sample/_analyze?analyzer=latin
GET icu_sample/_analyze
{
"analyzer": "latin",
"text": "你好" <2>
}
GET icu_sample/_analyze?analyzer=latin
GET icu_sample/_analyze
{
"analyzer": "latin",
"text": "здравствуйте" <3>
}
GET icu_sample/_analyze?analyzer=latin
GET icu_sample/_analyze
{
"analyzer": "latin",
"text": "こんにちは" <4>
}

54
docs/plugins/analysis-kuromoji.asciidoc
View File

@ -175,7 +175,11 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=東京スカイツリー
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "東京スカイツリー"
}
--------------------------------------------------
// CONSOLE
@ -228,7 +232,11 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=飲み
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "飲み"
}
--------------------------------------------------
// CONSOLE
@ -290,7 +298,11 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=寿司がおいしいね
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "寿司がおいしいね"
}
--------------------------------------------------
// CONSOLE
@ -363,9 +375,17 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=katakana_analyzer&text=寿司 <1>
POST kuromoji_sample/_analyze
{
"analyzer": "katakana_analyzer",
"text": "寿司" <1>
}
POST kuromoji_sample/_analyze?analyzer=romaji_analyzer&text=寿司 <2>
POST kuromoji_sample/_analyze
{
"analyzer": "romaji_analyzer",
"text": "寿司" <2>
}
--------------------------------------------------
// CONSOLE
@ -413,9 +433,17 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=コピー <1>
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "コピー" <1>
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=サーバー <2>
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "サーバー" <2>
}
--------------------------------------------------
// CONSOLE
@ -461,7 +489,11 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=analyzer_with_ja_stop&text=ストップは消える
POST kuromoji_sample/_analyze
{
"analyzer": "analyzer_with_ja_stop",
"text": "ストップは消える"
}
--------------------------------------------------
// CONSOLE
@ -507,7 +539,11 @@ PUT kuromoji_sample
}
}
POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=一〇〇〇
POST kuromoji_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "一〇〇〇"
}
--------------------------------------------------
// CONSOLE

6
docs/plugins/analysis-phonetic.asciidoc
View File

@ -82,7 +82,11 @@ PUT phonetic_sample
}
}
POST phonetic_sample/_analyze?analyzer=my_analyzer&text=Joe Bloggs <1>
POST phonetic_sample/_analyze
{
"analyzer": "my_analyzer",
"text": "Joe Bloggs" <1>
}
--------------------------------------------------
// CONSOLE

15
docs/reference/indices/analyze.asciidoc
View File

@ -100,21 +100,6 @@ curl -XGET 'localhost:9200/test/_analyze' -d '
Will cause the analysis to happen based on the analyzer configured in the
mapping for `obj1.field1` (and if not, the default index analyzer).
All parameters can also supplied as request parameters. For example:
[source,js]
--------------------------------------------------
curl -XGET 'localhost:9200/_analyze?tokenizer=keyword&filter=lowercase&text=this+is+a+test'
--------------------------------------------------
For backwards compatibility, we also accept the text parameter as the body of the request,
provided it doesn't start with `{` :
[source,js]
--------------------------------------------------
curl -XGET 'localhost:9200/_analyze?tokenizer=keyword&filter=lowercase&char_filter=html_strip' -d 'this is a <b>test</b>'
--------------------------------------------------
=== Explain Analyze
If you want to get more advanced details, set `explain` to `true` (defaults to `false`). It will output all token attributes for each token.

6
docs/reference/mapping/params/analyzer.asciidoc
View File

@ -60,13 +60,15 @@ PUT /my_index
}
}
GET my_index/_analyze?field=text <3>
GET my_index/_analyze <3>
{
"field": "text",
"text": "The quick Brown Foxes."
}
GET my_index/_analyze?field=text.english <4>
GET my_index/_analyze <4>
{
"field": "text.english",
"text": "The quick Brown Foxes."
}
--------------------------------------------------

10
plugins/analysis-icu/src/test/resources/rest-api-spec/test/analysis_icu/10_basic.yaml
View File

@ -3,6 +3,7 @@
"Tokenizer":
- do:
indices.analyze:
body:
text: Foo Bar
tokenizer: icu_tokenizer
- length: { tokens: 2 }
@ -12,7 +13,8 @@
"Normalization filter":
- do:
indices.analyze:
filter: icu_normalizer
body:
filter: [icu_normalizer]
text: Foo Bar Ruß
tokenizer: keyword
- length: { tokens: 1 }
@ -21,7 +23,8 @@
"Normalization charfilter":
- do:
indices.analyze:
char_filter: icu_normalizer
body:
char_filter: [icu_normalizer]
text: Foo Bar Ruß
tokenizer: keyword
- length: { tokens: 1 }
@ -30,7 +33,8 @@
"Folding filter":
- do:
indices.analyze:
filter: icu_folding
body:
filter: [icu_folding]
text: Foo Bar résumé
tokenizer: keyword
- length: { tokens: 1 }

11
plugins/analysis-kuromoji/src/test/resources/rest-api-spec/test/analysis_kuromoji/10_basic.yaml
View File

@ -4,6 +4,7 @@
"Analyzer":
- do:
indices.analyze:
body:
text: JR新宿駅の近くにビールを飲みに行こうか
analyzer: kuromoji
- length: { tokens: 7 }
@ -18,6 +19,7 @@
"Tokenizer":
- do:
indices.analyze:
body:
text: 関西国際空港
tokenizer: kuromoji_tokenizer
- length: { tokens: 4 }
@ -29,26 +31,29 @@
"Baseform filter":
- do:
indices.analyze:
body:
text: 飲み
tokenizer: kuromoji_tokenizer
filter: kuromoji_baseform
filter: [kuromoji_baseform]
- length: { tokens: 1 }
- match: { tokens.0.token: 飲む }
---
"Reading filter":
- do:
indices.analyze:
body:
text: 寿司
tokenizer: kuromoji_tokenizer
filter: kuromoji_readingform
filter: [kuromoji_readingform]
- length: { tokens: 1 }
- match: { tokens.0.token: スシ }
---
"Stemming filter":
- do:
indices.analyze:
body:
text: サーバー
tokenizer: kuromoji_tokenizer
filter: kuromoji_stemmer
filter: [kuromoji_stemmer]
- length: { tokens: 1 }
- match: { tokens.0.token: サーバ }

1
plugins/analysis-phonetic/src/test/resources/rest-api-spec/test/analysis_phonetic/10_metaphone.yaml
View File

@ -22,6 +22,7 @@
- do:
indices.analyze:
index: phonetic_sample
body:
analyzer: my_analyzer
text: Joe Bloggs

1
plugins/analysis-phonetic/src/test/resources/rest-api-spec/test/analysis_phonetic/20_double_metaphone.yaml
View File

@ -22,6 +22,7 @@
- do:
indices.analyze:
index: phonetic_sample
body:
analyzer: my_analyzer
text: supercalifragilisticexpialidocious

1
plugins/analysis-phonetic/src/test/resources/rest-api-spec/test/analysis_phonetic/30_beider_morse.yaml
View File

@ -24,6 +24,7 @@
- do:
indices.analyze:
index: phonetic_sample
body:
analyzer: my_analyzer
text: Szwarc

1
plugins/analysis-phonetic/src/test/resources/rest-api-spec/test/analysis_phonetic/50_daitch_mokotoff.yaml
View File

@ -21,6 +21,7 @@
- do:
indices.analyze:
index: phonetic_sample
body:
analyzer: my_analyzer
text: Moskowitz

2
plugins/analysis-smartcn/src/test/resources/rest-api-spec/test/analysis_smartcn/10_basic.yaml
View File

@ -3,6 +3,7 @@
"Tokenizer":
- do:
indices.analyze:
body:
text: 我购买了道具和服装。
tokenizer: smartcn_tokenizer
- length: { tokens: 7 }
@ -17,6 +18,7 @@
"Analyzer":
- do:
indices.analyze:
body:
text: 我购买了道具和服装。
analyzer: smartcn
- length: { tokens: 6 }

4
plugins/analysis-stempel/src/test/resources/rest-api-spec/test/analysis_stempel/10_basic.yaml
View File

@ -3,15 +3,17 @@
"Stemmer":
- do:
indices.analyze:
body:
text: studenci
tokenizer: keyword
filter: polish_stem
filter: [polish_stem]
- length: { tokens: 1 }
- match: { tokens.0.token: student }
---
"Analyzer":
- do:
indices.analyze:
body:
text: studenta był
analyzer: polish
- length: { tokens: 1 }

15
rest-api-spec/src/main/resources/rest-api-spec/test/indices.analyze/10_analyze.yaml
View File

@ -8,6 +8,7 @@ setup:
"Basic test":
- do:
indices.analyze:
body:
text: Foo Bar
- length: { tokens: 2 }
- match: { tokens.0.token: foo }
@ -17,7 +18,8 @@ setup:
"Tokenizer and filter":
- do:
indices.analyze:
filter: lowercase
body:
filter: [lowercase]
text: Foo Bar
tokenizer: keyword
- length: { tokens: 1 }
@ -38,8 +40,9 @@ setup:
- do:
indices.analyze:
field: text
index: test
body:
field: text
text: Foo Bar!
- length: { tokens: 2 }
- match: { tokens.0.token: Foo }
@ -52,14 +55,6 @@ setup:
- length: {tokens: 1 }
- match: { tokens.0.token: foo bar }
---
"Body params override query string":
- do:
indices.analyze:
text: Foo Bar
body: { "text": "Bar Foo", "filter": ["lowercase"], "tokenizer": keyword }
- length: {tokens: 1 }
- match: { tokens.0.token: bar foo }
---
"Array text":
- do:
indices.analyze: