Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalysisFeatureProcessorNGramEncoding.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<DataframeAnalysisFeatureProcessorNGramEncoding.Builder>

co.elastic.clients.elasticsearch.ml.DataframeAnalysisFeatureProcessorNGramEncoding.Builder

All Implemented Interfaces:

WithJson<DataframeAnalysisFeatureProcessorNGramEncoding.Builder>, ObjectBuilder<DataframeAnalysisFeatureProcessorNGramEncoding>

Enclosing class:

DataframeAnalysisFeatureProcessorNGramEncoding

public static class DataframeAnalysisFeatureProcessorNGramEncoding.Builder
extends WithJsonObjectBuilderBase<DataframeAnalysisFeatureProcessorNGramEncoding.Builder>
implements ObjectBuilder<DataframeAnalysisFeatureProcessorNGramEncoding>

Builder for DataframeAnalysisFeatureProcessorNGramEncoding.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeAnalysisFeatureProcessorNGramEncoding	build()	Builds a DataframeAnalysisFeatureProcessorNGramEncoding.
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	custom(java.lang.Boolean value)	API name: custom
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	featurePrefix(java.lang.String value)	The feature name prefix.
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	field(java.lang.String value)	Required - The name of the text field to encode.
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	length(java.lang.Integer value)	Specifies the length of the n-gram substring.
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	nGrams(java.lang.Integer value, java.lang.Integer... values)	Required - Specifies which n-grams to gather.
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	nGrams(java.util.List<java.lang.Integer> list)	Required - Specifies which n-grams to gather.
protected DataframeAnalysisFeatureProcessorNGramEncoding.Builder	self()
DataframeAnalysisFeatureProcessorNGramEncoding.Builder	start(java.lang.Integer value)	Specifies the zero-indexed start of the n-gram substring.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

featurePrefix

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder featurePrefix(@Nullable
java.lang.String value)

The feature name prefix. Defaults to ngram_<start>_<length>.

API name: feature_prefix

field

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder field(java.lang.String value)

Required - The name of the text field to encode.

API name: field

length

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder length(@Nullable
java.lang.Integer value)

Specifies the length of the n-gram substring. Defaults to 50. Must be greater than 0.

API name: length

nGrams

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder nGrams(java.util.List<java.lang.Integer> list)

Required - Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.

API name: n_grams

Adds all elements of list to nGrams.

nGrams

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder nGrams(java.lang.Integer value,
java.lang.Integer... values)

Required - Specifies which n-grams to gather. It’s an array of integer values where the minimum value is 1, and a maximum value is 5.

API name: n_grams

Adds one or more values to nGrams.

start

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder start(@Nullable
java.lang.Integer value)

Specifies the zero-indexed start of the n-gram substring. Negative values are allowed for encoding n-grams of string suffixes. Defaults to 0.

API name: start

custom

public final DataframeAnalysisFeatureProcessorNGramEncoding.Builder custom(@Nullable
java.lang.Boolean value)

API name: custom

self

protected DataframeAnalysisFeatureProcessorNGramEncoding.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataframeAnalysisFeatureProcessorNGramEncoding.Builder>

build

public DataframeAnalysisFeatureProcessorNGramEncoding build()

Builds a DataframeAnalysisFeatureProcessorNGramEncoding.

Specified by:

build in interface ObjectBuilder<DataframeAnalysisFeatureProcessorNGramEncoding>

Throws:

java.lang.NullPointerException - if some of the required fields are null.