Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel

Class NlpConfigUpdate

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.NlpConfigUpdate

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentObject, InferenceConfigUpdate, NamedXContentObject

Direct Known Subclasses:

FillMaskConfigUpdate, NerConfigUpdate, PassThroughConfigUpdate, QuestionAnsweringConfigUpdate, TextClassificationConfigUpdate, TextEmbeddingConfigUpdate, TextExpansionConfigUpdate, TextSimilarityConfigUpdate, ZeroShotClassificationConfigUpdate

public abstract class NlpConfigUpdate
extends Object
implements InferenceConfigUpdate, NamedXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfigUpdate

InferenceConfigUpdate.Builder<T extends InferenceConfigUpdate.Builder<T,U>,U extends InferenceConfigUpdate>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final TokenizationUpdate	tokenizationUpdate

Fields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfigUpdate

RESERVED_ML_FIELD_NAMES

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NlpConfigUpdate(StreamInput in)
NlpConfigUpdate(TokenizationUpdate tokenizationUpdate)

Method Summary

Modifier and Type	Method	Description
abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
String	getName()	Required because this class implements 2 interfaces defining the method String getName() and the compiler insists it must be resolved here in the abstract class
TokenizationUpdate	getTokenizationUpdate()
protected boolean	isNoop()
static TokenizationUpdate	tokenizationFromMap(Map<String,Object> map)
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfigUpdate

getResultsField, isEmpty, isSupported, newBuilder

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion, getWriteableName, supportsVersion

Field Details

tokenizationUpdate

protected final TokenizationUpdate tokenizationUpdate

Constructor Details

NlpConfigUpdate

public NlpConfigUpdate(@Nullable
 TokenizationUpdate tokenizationUpdate)

NlpConfigUpdate

public NlpConfigUpdate(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

tokenizationFromMap

public static TokenizationUpdate tokenizationFromMap(Map<String,Object> map)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

isNoop

protected boolean isNoop()

getTokenizationUpdate

public TokenizationUpdate getTokenizationUpdate()

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                                 throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContentBody

public abstract XContentBuilder doXContentBody(XContentBuilder builder,
 ToXContent.Params params)
                                        throws IOException

Throws:

IOException

getName

public String getName()

Required because this class implements 2 interfaces defining the method String getName() and the compiler insists it must be resolved here in the abstract class

Specified by:

getName in interface InferenceConfigUpdate

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized