Module org.elasticsearch.xcore
Class LearningToRankConfig
java.lang.Object
org.elasticsearch.xpack.core.ml.inference.trainedmodel.RegressionConfig
org.elasticsearch.xpack.core.ml.inference.trainedmodel.LearningToRankConfig
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<LearningToRankConfig>,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,InferenceConfig,LenientlyParsedInferenceConfig,StrictlyParsedInferenceConfig,NamedXContentObject
public class LearningToRankConfig
extends RegressionConfig
implements Rewriteable<LearningToRankConfig>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldstatic LearningToRankConfigstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig
DEFAULT_RESULTS_FIELD, DEFAULT_TOP_CLASSES_RESULTS_FIELD, RESULTS_FIELDFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY -
Constructor Summary
ConstructorsConstructorDescriptionLearningToRankConfig(Integer numTopFeatureImportanceValues, List<LearningToRankFeatureExtractorBuilder> featureExtractorBuilders, Map<String, Object> paramsDefaults) -
Method Summary
Modifier and TypeMethodDescriptionstatic LearningToRankConfig.Builderbuilder(LearningToRankConfig config) booleanstatic LearningToRankConfigfromXContentLenient(org.elasticsearch.xcontent.XContentParser parser) static LearningToRankConfigfromXContentStrict(org.elasticsearch.xcontent.XContentParser parser) getDefaultInput(TrainedModelType modelType) All nodes in the cluster must have at least this MlConfigVersion attributeAll communication in the cluster must use at least this versiongetName()inthashCode()booleanbooleanisTargetTypeSupported(TargetType targetType) booleanbooleanbooleanfinal StringtoString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) validateTrainedModelInput(TrainedModelInput input, boolean forCreation, ActionRequestValidationException validationException) voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.xpack.core.ml.inference.trainedmodel.RegressionConfig
apply, builder, getNumTopFeatureImportanceValues, requestingImportanceMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig
getMinimalSupportedVersion, getMinLicenseSupported, incompatibleUpdateExceptionMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final org.elasticsearch.xcontent.ParseField NAME -
NUM_TOP_FEATURE_IMPORTANCE_VALUES
public static final org.elasticsearch.xcontent.ParseField NUM_TOP_FEATURE_IMPORTANCE_VALUES -
FEATURE_EXTRACTORS
public static final org.elasticsearch.xcontent.ParseField FEATURE_EXTRACTORS -
DEFAULT_PARAMS
public static final org.elasticsearch.xcontent.ParseField DEFAULT_PARAMS -
EMPTY_PARAMS
-
-
Constructor Details
-
LearningToRankConfig
-
LearningToRankConfig
- Throws:
IOException
-
-
Method Details
-
fromXContentStrict
public static LearningToRankConfig fromXContentStrict(org.elasticsearch.xcontent.XContentParser parser) -
fromXContentLenient
public static LearningToRankConfig fromXContentLenient(org.elasticsearch.xcontent.XContentParser parser) -
builder
-
getFeatureExtractorBuilders
-
getQueryFeatureExtractorBuilders
-
getResultsField
- Specified by:
getResultsFieldin interfaceInferenceConfig- Overrides:
getResultsFieldin classRegressionConfig
-
getParamsDefaults
-
isAllocateOnly
public boolean isAllocateOnly()- Specified by:
isAllocateOnlyin interfaceInferenceConfig- Overrides:
isAllocateOnlyin classRegressionConfig
-
supportsIngestPipeline
public boolean supportsIngestPipeline()- Specified by:
supportsIngestPipelinein interfaceInferenceConfig
-
supportsPipelineAggregation
public boolean supportsPipelineAggregation()- Specified by:
supportsPipelineAggregationin interfaceInferenceConfig
-
supportsSearchRescorer
public boolean supportsSearchRescorer()- Specified by:
supportsSearchRescorerin interfaceInferenceConfig
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable- Overrides:
getWriteableNamein classRegressionConfig
-
writeTo
- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classRegressionConfig- Throws:
IOException
-
getName
- Specified by:
getNamein interfaceNamedXContentObject- Overrides:
getNamein classRegressionConfig- Returns:
- The name of the XContentObject that is to be serialized
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Overrides:
toXContentin classRegressionConfig- Throws:
IOException
-
equals
- Overrides:
equalsin classRegressionConfig
-
hashCode
public int hashCode()- Overrides:
hashCodein classRegressionConfig
-
toString
-
isTargetTypeSupported
- Specified by:
isTargetTypeSupportedin interfaceInferenceConfig- Overrides:
isTargetTypeSupportedin classRegressionConfig
-
getMinimalSupportedMlConfigVersion
Description copied from interface:InferenceConfigAll nodes in the cluster must have at least this MlConfigVersion attribute- Specified by:
getMinimalSupportedMlConfigVersionin interfaceInferenceConfig- Overrides:
getMinimalSupportedMlConfigVersionin classRegressionConfig
-
getMinimalSupportedTransportVersion
Description copied from interface:InferenceConfigAll communication in the cluster must use at least this version- Specified by:
getMinimalSupportedTransportVersionin interfaceInferenceConfig- Overrides:
getMinimalSupportedTransportVersionin classRegressionConfig
-
getMinLicenseSupportedForAction
- Specified by:
getMinLicenseSupportedForActionin interfaceInferenceConfig
-
rewrite
- Specified by:
rewritein interfaceRewriteable<LearningToRankConfig>- Throws:
IOException
-
getDefaultInput
- Specified by:
getDefaultInputin interfaceInferenceConfig
-
validateTrainedModelInput
public ActionRequestValidationException validateTrainedModelInput(TrainedModelInput input, boolean forCreation, ActionRequestValidationException validationException) - Specified by:
validateTrainedModelInputin interfaceInferenceConfig
-