Module org.elasticsearch.xcore

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

Interface InferenceConfig

All Superinterfaces:

NamedWriteable, NamedXContentObject, ToXContent, ToXContentObject, VersionedNamedWriteable, Writeable

All Known Subinterfaces:

LenientlyParsedInferenceConfig, NlpConfig, StrictlyParsedInferenceConfig

All Known Implementing Classes:

ClassificationConfig, FillMaskConfig, LearningToRankConfig, NerConfig, NullInferenceConfig, PassThroughConfig, QuestionAnsweringConfig, RegressionConfig, TextClassificationConfig, TextEmbeddingConfig, TextExpansionConfig, TextSimilarityConfig, ZeroShotClassificationConfig

public interface InferenceConfig
extends NamedXContentObject, VersionedNamedWriteable

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	DEFAULT_RESULTS_FIELD
static final String	DEFAULT_TOP_CLASSES_RESULTS_FIELD
static final ParseField	RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
InferenceConfig	apply(InferenceConfigUpdate update)	Return a copy of this with the settings updated by the values in update.
default TrainedModelInput	getDefaultInput(TrainedModelType modelType)
MlConfigVersion	getMinimalSupportedMlConfigVersion()	All nodes in the cluster must have at least this MlConfigVersion attribute
TransportVersion	getMinimalSupportedTransportVersion()	All communication in the cluster must use at least this version
default TransportVersion	getMinimalSupportedVersion()
default License.OperationMode	getMinLicenseSupported()
default License.OperationMode	getMinLicenseSupportedForAction(RestRequest.Method method)
String	getResultsField()
default ElasticsearchStatusException	incompatibleUpdateException(String updateName)
boolean	isAllocateOnly()
boolean	isTargetTypeSupported(TargetType targetType)
default boolean	requestingImportance()
default boolean	supportsIngestPipeline()
default boolean	supportsPipelineAggregation()
default boolean	supportsSearchRescorer()
default ActionRequestValidationException	validateTrainedModelInput(TrainedModelInput input, boolean forCreation, ActionRequestValidationException validationException)

Methods inherited from interface org.elasticsearch.xpack.core.ml.utils.NamedXContentObject

getName

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

getWriteableName, supportsVersion

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

writeTo

Field Details

DEFAULT_TOP_CLASSES_RESULTS_FIELD

static final String DEFAULT_TOP_CLASSES_RESULTS_FIELD

See Also:

• Constant Field Values

DEFAULT_RESULTS_FIELD

static final String DEFAULT_RESULTS_FIELD

See Also:

• Constant Field Values

RESULTS_FIELD

static final ParseField RESULTS_FIELD

Method Details

isTargetTypeSupported

boolean isTargetTypeSupported(TargetType targetType)

apply

InferenceConfig apply(InferenceConfigUpdate update)

Return a copy of this with the settings updated by the values in update.

Parameters:

update - The update to apply

Returns:

A new updated config

getMinimalSupportedVersion

default TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

getMinimalSupportedMlConfigVersion

MlConfigVersion getMinimalSupportedMlConfigVersion()

All nodes in the cluster must have at least this MlConfigVersion attribute

getMinimalSupportedTransportVersion

TransportVersion getMinimalSupportedTransportVersion()

All communication in the cluster must use at least this version

requestingImportance

default boolean requestingImportance()

getResultsField

String getResultsField()

isAllocateOnly

boolean isAllocateOnly()

supportsIngestPipeline

default boolean supportsIngestPipeline()

supportsPipelineAggregation

default boolean supportsPipelineAggregation()

supportsSearchRescorer

default boolean supportsSearchRescorer()

getDefaultInput

@Nullable
default TrainedModelInput getDefaultInput(TrainedModelType modelType)

validateTrainedModelInput

default ActionRequestValidationException validateTrainedModelInput(TrainedModelInput input,
 boolean forCreation,
 ActionRequestValidationException validationException)

incompatibleUpdateException

default ElasticsearchStatusException incompatibleUpdateException(String updateName)

getMinLicenseSupported

default License.OperationMode getMinLicenseSupported()

getMinLicenseSupportedForAction

default License.OperationMode getMinLicenseSupportedForAction(RestRequest.Method method)