Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalysisFeatureProcessorNGramEncoding

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeAnalysisFeatureProcessorNGramEncoding

All Implemented Interfaces:

DataframeAnalysisFeatureProcessorVariant, JsonpSerializable

@JsonpDeserializable
public class DataframeAnalysisFeatureProcessorNGramEncoding
extends Object
implements DataframeAnalysisFeatureProcessorVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataframeAnalysisFeatureProcessorNGramEncoding.Builder	Builder for DataframeAnalysisFeatureProcessorNGramEncoding.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<DataframeAnalysisFeatureProcessorNGramEncoding>	_DESERIALIZER	Json deserializer for DataframeAnalysisFeatureProcessorNGramEncoding

Method Summary

Modifier and Type	Method	Description
DataframeAnalysisFeatureProcessor.Kind	_dataframeAnalysisFeatureProcessorKind()	DataframeAnalysisFeatureProcessor variant kind.
final Boolean	custom()	API name: custom
final String	featurePrefix()	The feature name prefix.
final String	field()	Required - The name of the text field to encode.
final Integer	length()	Specifies the length of the n-gram substring.
final List<Integer>	nGrams()	Required - Specifies which n-grams to gather.
static DataframeAnalysisFeatureProcessorNGramEncoding	of(Function<DataframeAnalysisFeatureProcessorNGramEncoding.Builder,ObjectBuilder<DataframeAnalysisFeatureProcessorNGramEncoding>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDataframeAnalysisFeatureProcessorNGramEncodingDeserializer(ObjectDeserializer<DataframeAnalysisFeatureProcessorNGramEncoding.Builder> op)
final Integer	start()	Specifies the zero-indexed start of the n-gram substring.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.ml.DataframeAnalysisFeatureProcessorVariant

_toDataframeAnalysisFeatureProcessor

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataframeAnalysisFeatureProcessorNGramEncoding> _DESERIALIZER

Json deserializer for DataframeAnalysisFeatureProcessorNGramEncoding

Method Details

of

public static DataframeAnalysisFeatureProcessorNGramEncoding of(Function<DataframeAnalysisFeatureProcessorNGramEncoding.Builder,ObjectBuilder<DataframeAnalysisFeatureProcessorNGramEncoding>> fn)

_dataframeAnalysisFeatureProcessorKind

public DataframeAnalysisFeatureProcessor.Kind _dataframeAnalysisFeatureProcessorKind()

DataframeAnalysisFeatureProcessor variant kind.

Specified by:

_dataframeAnalysisFeatureProcessorKind in interface DataframeAnalysisFeatureProcessorVariant

featurePrefix

@Nullable
public final String featurePrefix()

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

API name: feature_prefix

field

public final String field()

Required - The name of the text field to encode.

API name: field

length

@Nullable
public final Integer length()

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

API name: length

nGrams

public final List<Integer> nGrams()

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

start

@Nullable
public final Integer start()

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

@Nullable
public final Boolean custom()

API name: custom

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupDataframeAnalysisFeatureProcessorNGramEncodingDeserializer

protected static void setupDataframeAnalysisFeatureProcessorNGramEncodingDeserializer(ObjectDeserializer<DataframeAnalysisFeatureProcessorNGramEncoding.Builder> op)