Module org.elasticsearch.xcore

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

Class NlpClassificationInferenceResults

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.results.NlpClassificationInferenceResults

All Implemented Interfaces:

NamedWriteable, Writeable, InferenceResults, ToXContent, ToXContentFragment

Direct Known Subclasses:

FillMaskResults

public class NlpClassificationInferenceResults
extends Object

Nested Class Summary

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 boolean	isTruncated
static final String	NAME
protected final String	resultsField

Fields inherited from interface org.elasticsearch.inference.InferenceResults

MODEL_ID_RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NlpClassificationInferenceResults(String classificationLabel, List<TopClassEntry> topClasses, String resultsField, Double predictionProbability, boolean isTruncated)
NlpClassificationInferenceResults(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final Map<String,Object>	asMap()
Map<String,Object>	asMap(String outputField)
void	doWriteTo(StreamOutput out)
void	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object o)
String	getClassificationLabel()
Double	getPredictionProbability()
String	getResultsField()
List<TopClassEntry>	getTopClasses()
String	getWriteableName()
int	hashCode()
boolean	isTruncated()
Object	predictedValue()
String	toString()
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
final void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

resultsField

protected final String resultsField

isTruncated

protected final boolean isTruncated

Constructor Details

NlpClassificationInferenceResults

public NlpClassificationInferenceResults(String classificationLabel,
 List<TopClassEntry> topClasses,
 String resultsField,
 Double predictionProbability,
 boolean isTruncated)

NlpClassificationInferenceResults

public NlpClassificationInferenceResults(StreamInput in)
                                  throws IOException

Throws:

IOException

Method Details

getClassificationLabel

public String getClassificationLabel()

getTopClasses

public List<TopClassEntry> getTopClasses()

doWriteTo

public void doWriteTo(StreamOutput out)
               throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

hashCode

public int hashCode()

getPredictionProbability

public Double getPredictionProbability()

getResultsField

public String getResultsField()

predictedValue

public Object predictedValue()

getWriteableName

public String getWriteableName()

doXContentBody

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

Throws:

IOException

isTruncated

public boolean isTruncated()

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

asMap

public final Map<String,Object> asMap()

Specified by:

asMap in interface InferenceResults

asMap

public Map<String,Object> asMap(String outputField)

Specified by:

asMap in interface InferenceResults

toString

public String toString()

Overrides:

toString in class Object