Module org.elasticsearch.xcore
Class OutlierDetection
java.lang.Object
org.elasticsearch.xpack.core.ml.dataframe.analyses.OutlierDetection
- All Implemented Interfaces:
NamedWriteable,Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,DataFrameAnalysis
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumNested classes/interfaces inherited from interface org.elasticsearch.xpack.core.ml.dataframe.analyses.DataFrameAnalysis
DataFrameAnalysis.FieldInfoNested 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 final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic OutlierDetectionfromXContent(org.elasticsearch.xcontent.XContentParser parser, boolean ignoreUnknownFields) getAllowedCategoricalTypes(String fieldName) getParams(DataFrameAnalysis.FieldInfo fieldInfo) Returns the progress phases the analysis goes through in ordergetResultMappings(String resultsFieldName, FieldCapabilitiesResponse fieldCapabilitiesResponse) Returns fields for which the mappings should be either predefined or copied from source index to destination index.getStateDocIdPrefix(String jobId) Returns the document id prefix for the analysis stateinthashCode()inferenceConfig(DataFrameAnalysis.FieldInfo fieldInfo) booleanbooleanbooleanbooleanorg.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xpack.core.ml.dataframe.analyses.DataFrameAnalysis
getTrainingPercentMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final org.elasticsearch.xcontent.ParseField NAME -
N_NEIGHBORS
public static final org.elasticsearch.xcontent.ParseField N_NEIGHBORS -
METHOD
public static final org.elasticsearch.xcontent.ParseField METHOD -
FEATURE_INFLUENCE_THRESHOLD
public static final org.elasticsearch.xcontent.ParseField FEATURE_INFLUENCE_THRESHOLD -
COMPUTE_FEATURE_INFLUENCE
public static final org.elasticsearch.xcontent.ParseField COMPUTE_FEATURE_INFLUENCE -
OUTLIER_FRACTION
public static final org.elasticsearch.xcontent.ParseField OUTLIER_FRACTION -
STANDARDIZATION_ENABLED
public static final org.elasticsearch.xcontent.ParseField STANDARDIZATION_ENABLED
-
-
Constructor Details
-
OutlierDetection
- Throws:
IOException
-
-
Method Details
-
fromXContent
public static OutlierDetection fromXContent(org.elasticsearch.xcontent.XContentParser parser, boolean ignoreUnknownFields) -
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
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- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
getParams
- Specified by:
getParamsin interfaceDataFrameAnalysis- Parameters:
fieldInfo- Information about the fields like types and cardinalities- Returns:
- The analysis parameters as a map
-
supportsCategoricalFields
public boolean supportsCategoricalFields()- Specified by:
supportsCategoricalFieldsin interfaceDataFrameAnalysis- Returns:
trueif this analysis supports fields with categorical values (i.e. text, keyword, ip)
-
getAllowedCategoricalTypes
- Specified by:
getAllowedCategoricalTypesin interfaceDataFrameAnalysis- Parameters:
fieldName- field for which the allowed categorical types should be returned- Returns:
- The types treated as categorical for the given field
-
getRequiredFields
- Specified by:
getRequiredFieldsin interfaceDataFrameAnalysis- Returns:
- The names and types of the fields that analyzed documents must have for the analysis to operate
-
getFieldCardinalityConstraints
- Specified by:
getFieldCardinalityConstraintsin interfaceDataFrameAnalysis- Returns:
Listcontaining cardinality constraints for the selected (analysis-specific) fields
-
getResultMappings
public Map<String,Object> getResultMappings(String resultsFieldName, FieldCapabilitiesResponse fieldCapabilitiesResponse) Description copied from interface:DataFrameAnalysisReturns fields for which the mappings should be either predefined or copied from source index to destination index.- Specified by:
getResultMappingsin interfaceDataFrameAnalysis- Parameters:
resultsFieldName- name of the results field under which all the results are storedfieldCapabilitiesResponse- field capabilities fetched for this analysis' required fields- Returns:
Mapcontaining fields for which the mappings should be handled explicitly
-
supportsMissingValues
public boolean supportsMissingValues()- Specified by:
supportsMissingValuesin interfaceDataFrameAnalysis- Returns:
trueif this analysis supports data frame rows with missing values
-
persistsState
public boolean persistsState()- Specified by:
persistsStatein interfaceDataFrameAnalysis- Returns:
trueif this analysis persists state that can later be used to restore from a given point
-
getStateDocIdPrefix
Description copied from interface:DataFrameAnalysisReturns the document id prefix for the analysis state- Specified by:
getStateDocIdPrefixin interfaceDataFrameAnalysis
-
getProgressPhases
Description copied from interface:DataFrameAnalysisReturns the progress phases the analysis goes through in order- Specified by:
getProgressPhasesin interfaceDataFrameAnalysis
-
inferenceConfig
- Specified by:
inferenceConfigin interfaceDataFrameAnalysis- Returns:
- the analysis inference config or
nullif inference is not supported
-
supportsInference
public boolean supportsInference()- Specified by:
supportsInferencein interfaceDataFrameAnalysis- Returns:
trueif this analysis trains a model that can be used for inference
-