Module org.elasticsearch.xcore

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

Class TextClassificationConfigUpdate

java.lang.Object

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

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

All Implemented Interfaces:

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

public class TextClassificationConfigUpdate
extends NlpConfigUpdate
implements NamedXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextClassificationConfigUpdate.Builder

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
static final String	NAME

Fields inherited from class org.elasticsearch.xpack.core.ml.inference.trainedmodel.NlpConfigUpdate

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
TextClassificationConfigUpdate(List<String> classificationLabels, Integer numTopClasses, String resultsField, TokenizationUpdate tokenizationUpdate)
TextClassificationConfigUpdate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object o)
static TextClassificationConfigUpdate	fromMap(Map<String,Object> map)
static TextClassificationConfigUpdate	fromXContentStrict(XContentParser parser)
List<String>	getClassificationLabels()
TransportVersion	getMinimalSupportedVersion()
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
Integer	getNumTopClasses()
String	getResultsField()
String	getWriteableName()
int	hashCode()
boolean	isSupported(InferenceConfig config)
InferenceConfigUpdate.Builder<? extends InferenceConfigUpdate.Builder<?,?>,? extends InferenceConfigUpdate>	newBuilder()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.core.ml.inference.trainedmodel.NlpConfigUpdate

getTokenizationUpdate, isNoop, tokenizationFromMap, toXContent

Methods inherited from class java.lang.Object

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

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

isEmpty

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

supportsVersion

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TextClassificationConfigUpdate

public TextClassificationConfigUpdate(List<String> classificationLabels,
 Integer numTopClasses,
 String resultsField,
 TokenizationUpdate tokenizationUpdate)

TextClassificationConfigUpdate

public TextClassificationConfigUpdate(StreamInput in)
                               throws IOException

Throws:

IOException

Method Details

fromMap

public static TextClassificationConfigUpdate fromMap(Map<String,Object> map)

fromXContentStrict

public static TextClassificationConfigUpdate fromXContentStrict(XContentParser parser)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getName

public String getName()

Description copied from class: NlpConfigUpdate

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

Overrides:

getName in class NlpConfigUpdate

Returns:

The name of the XContentObject that is to be serialized

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class NlpConfigUpdate

Throws:

IOException

isSupported

public boolean isSupported(InferenceConfig config)

Specified by:

isSupported in interface InferenceConfigUpdate

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceConfigUpdate

getNumTopClasses

public Integer getNumTopClasses()

getClassificationLabels

public List<String> getClassificationLabels()

newBuilder

public InferenceConfigUpdate.Builder<? extends InferenceConfigUpdate.Builder<?,?>,? extends InferenceConfigUpdate> newBuilder()

Specified by:

newBuilder in interface InferenceConfigUpdate

doXContentBody

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

Specified by:

doXContentBody in class NlpConfigUpdate

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object