Module org.elasticsearch.xcore

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

Class ClassificationInferenceResults

java.lang.Object

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, InferenceResults, ToXContent, ToXContentFragment

public class ClassificationInferenceResults
extends SingleValueInferenceResults

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
static final String	NAME
static final String	PREDICTION_PROBABILITY
static final String	PREDICTION_SCORE
protected final String	resultsField

Fields inherited from class org.elasticsearch.xpack.core.ml.inference.results.SingleValueInferenceResults

FEATURE_IMPORTANCE

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
ClassificationInferenceResults(double value, String classificationLabel, List<TopClassEntry> topClasses, List<ClassificationFeatureImportance> featureImportance, String topNumClassesField, String resultsField, PredictionFieldType predictionFieldType, int numTopFeatureImportanceValues, Double predictionProbability, Double predictionScore)
ClassificationInferenceResults(double value, String classificationLabel, List<TopClassEntry> topClasses, List<ClassificationFeatureImportance> featureImportance, InferenceConfig config, Double predictionProbability, Double predictionScore)
ClassificationInferenceResults(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
Map<String,Object>	asMap(String outputField)
boolean	equals(Object object)
String	getClassificationLabel()
List<ClassificationFeatureImportance>	getFeatureImportance()
PredictionFieldType	getPredictionFieldType()
Double	getPredictionProbability()
Double	getPredictionScore()
String	getResultsField()
List<TopClassEntry>	getTopClasses()
String	getWriteableName()
int	hashCode()
Object	predictedValue()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	valueAsString()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.core.ml.inference.results.SingleValueInferenceResults

value

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

PREDICTION_PROBABILITY

public static final String PREDICTION_PROBABILITY

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

PREDICTION_SCORE

public static final String PREDICTION_SCORE

See Also:

• Constant Field Values

resultsField

protected final String resultsField

Constructor Details

ClassificationInferenceResults

public ClassificationInferenceResults(double value,
 String classificationLabel,
 List<TopClassEntry> topClasses,
 List<ClassificationFeatureImportance> featureImportance,
 InferenceConfig config,
 Double predictionProbability,
 Double predictionScore)

ClassificationInferenceResults

public ClassificationInferenceResults(double value,
 String classificationLabel,
 List<TopClassEntry> topClasses,
 List<ClassificationFeatureImportance> featureImportance,
 String topNumClassesField,
 String resultsField,
 PredictionFieldType predictionFieldType,
 int numTopFeatureImportanceValues,
 Double predictionProbability,
 Double predictionScore)

ClassificationInferenceResults

public ClassificationInferenceResults(StreamInput in)
                               throws IOException

Throws:

IOException

Method Details

getClassificationLabel

public String getClassificationLabel()

getTopClasses

public List<TopClassEntry> getTopClasses()

getPredictionFieldType

public PredictionFieldType getPredictionFieldType()

getFeatureImportance

public List<ClassificationFeatureImportance> getFeatureImportance()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SingleValueInferenceResults

Throws:

IOException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

valueAsString

public String valueAsString()

Overrides:

valueAsString in class SingleValueInferenceResults

predictedValue

public Object predictedValue()

getPredictionProbability

public Double getPredictionProbability()

getPredictionScore

public Double getPredictionScore()

getResultsField

public String getResultsField()

asMap

public Map<String,Object> asMap()

asMap

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

getWriteableName

public String getWriteableName()

toXContent

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

Throws:

IOException