Module org.elasticsearch.server

Package org.elasticsearch.inference

Interface InferenceResults

All Superinterfaces:

NamedWriteable, ToXContent, ToXContentFragment, Writeable

public interface InferenceResults
extends NamedWriteable, ToXContentFragment

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	MODEL_ID_RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	Convert to a map
Map<String,Object>	asMap(String outputField)	Convert to a map placing the inference result in outputField
String	getResultsField()
Object	predictedValue()
static void	writeResult(InferenceResults results, IngestDocument ingestDocument, String resultField, String modelId)
static void	writeResultToField(InferenceResults results, IngestDocument ingestDocument, String basePath, String outputField, String modelId, boolean includeModelId)

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

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

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

writeTo

Field Details

MODEL_ID_RESULTS_FIELD

static final String MODEL_ID_RESULTS_FIELD

See Also:

• Constant Field Values

Method Details

writeResult

static void writeResult(InferenceResults results,
 IngestDocument ingestDocument,
 String resultField,
 String modelId)

writeResultToField

static void writeResultToField(InferenceResults results,
 IngestDocument ingestDocument,
 @Nullable
 String basePath,
 String outputField,
 String modelId,
 boolean includeModelId)

getResultsField

String getResultsField()

asMap

Map<String,Object> asMap()

Convert to a map

Returns:

Map representation of the InferenceResult

asMap

Map<String,Object> asMap(String outputField)

Convert to a map placing the inference result in outputField

Parameters:

outputField - Write the inference result to this field

Returns:

Map representation of the InferenceResult

predictedValue

Object predictedValue()