Class AnalyzeRequest.Builder
- All Implemented Interfaces:
WithJson<AnalyzeRequest.Builder>
,ObjectBuilder<AnalyzeRequest>
- Enclosing class:
- AnalyzeRequest
AnalyzeRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnalyzeRequest.Builder
The name of the analyzer that should be applied to the providedtext
.final AnalyzeRequest.Builder
attributes
(String value, String... values) Array of token attributes used to filter the output of theexplain
parameter.final AnalyzeRequest.Builder
attributes
(List<String> list) Array of token attributes used to filter the output of theexplain
parameter.build()
Builds aAnalyzeRequest
.final AnalyzeRequest.Builder
charFilter
(CharFilter value, CharFilter... values) Array of character filters used to preprocess characters before the tokenizer.final AnalyzeRequest.Builder
Array of character filters used to preprocess characters before the tokenizer.final AnalyzeRequest.Builder
charFilter
(List<CharFilter> list) Array of character filters used to preprocess characters before the tokenizer.final AnalyzeRequest.Builder
Iftrue
, the response includes token attributes and additional details.final AnalyzeRequest.Builder
Field used to derive the analyzer.final AnalyzeRequest.Builder
filter
(TokenFilter value, TokenFilter... values) Array of token filters used to apply after the tokenizer.final AnalyzeRequest.Builder
Array of token filters used to apply after the tokenizer.final AnalyzeRequest.Builder
filter
(List<TokenFilter> list) Array of token filters used to apply after the tokenizer.final AnalyzeRequest.Builder
Index used to derive the analyzer.final AnalyzeRequest.Builder
normalizer
(String value) Normalizer to use to convert text into a single token.protected AnalyzeRequest.Builder
self()
final AnalyzeRequest.Builder
Text to analyze.final AnalyzeRequest.Builder
Text to analyze.final AnalyzeRequest.Builder
Tokenizer to use to convert text into tokens.final AnalyzeRequest.Builder
Tokenizer to use to convert text into tokens.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
analyzer
The name of the analyzer that should be applied to the providedtext
. This could be a built-in analyzer, or an analyzer that’s been configured in the index.API name:
analyzer
-
attributes
Array of token attributes used to filter the output of theexplain
parameter.API name:
attributes
Adds all elements of
list
toattributes
. -
attributes
Array of token attributes used to filter the output of theexplain
parameter.API name:
attributes
Adds one or more values to
attributes
. -
charFilter
Array of character filters used to preprocess characters before the tokenizer.API name:
char_filter
Adds all elements of
list
tocharFilter
. -
charFilter
Array of character filters used to preprocess characters before the tokenizer.API name:
char_filter
Adds one or more values to
charFilter
. -
charFilter
public final AnalyzeRequest.Builder charFilter(Function<CharFilter.Builder, ObjectBuilder<CharFilter>> fn) Array of character filters used to preprocess characters before the tokenizer.API name:
char_filter
Adds a value to
charFilter
using a builder lambda. -
explain
Iftrue
, the response includes token attributes and additional details.API name:
explain
-
field
Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, theanalyzer
parameter overrides this value.API name:
field
-
filter
Array of token filters used to apply after the tokenizer.API name:
filter
Adds all elements of
list
tofilter
. -
filter
Array of token filters used to apply after the tokenizer.API name:
filter
Adds one or more values to
filter
. -
filter
public final AnalyzeRequest.Builder filter(Function<TokenFilter.Builder, ObjectBuilder<TokenFilter>> fn) Array of token filters used to apply after the tokenizer.API name:
filter
Adds a value to
filter
using a builder lambda. -
index
Index used to derive the analyzer. If specified, theanalyzer
or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.API name:
index
-
normalizer
Normalizer to use to convert text into a single token.API name:
normalizer
-
text
Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.API name:
text
Adds all elements of
list
totext
. -
text
Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.API name:
text
Adds one or more values to
text
. -
tokenizer
Tokenizer to use to convert text into tokens.API name:
tokenizer
-
tokenizer
public final AnalyzeRequest.Builder tokenizer(Function<Tokenizer.Builder, ObjectBuilder<Tokenizer>> fn) Tokenizer to use to convert text into tokens.API name:
tokenizer
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<AnalyzeRequest.Builder>
-
build
Builds aAnalyzeRequest
.- Specified by:
build
in interfaceObjectBuilder<AnalyzeRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-