Module org.elasticsearch.xcore
Interface DataFrameAnalysis
- All Superinterfaces:
NamedWriteable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,Writeable
- All Known Implementing Classes:
Classification,OutlierDetection,Regression
public interface DataFrameAnalysis
extends org.elasticsearch.xcontent.ToXContentObject, NamedWriteable
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceSummarizes information about the fields that is necessary for analysis to generate the parameters needed for the process configuration.Nested 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
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptiongetAllowedCategoricalTypes(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 statedefault doubleinferenceConfig(DataFrameAnalysis.FieldInfo fieldInfo) booleanbooleanbooleanbooleanMethods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable
getWriteableNameMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Method Details
-
getParams
- Parameters:
fieldInfo- Information about the fields like types and cardinalities- Returns:
- The analysis parameters as a map
-
supportsCategoricalFields
boolean supportsCategoricalFields()- Returns:
trueif this analysis supports fields with categorical values (i.e. text, keyword, ip)
-
getAllowedCategoricalTypes
- Parameters:
fieldName- field for which the allowed categorical types should be returned- Returns:
- The types treated as categorical for the given field
-
getRequiredFields
List<RequiredField> getRequiredFields()- Returns:
- The names and types of the fields that analyzed documents must have for the analysis to operate
-
getFieldCardinalityConstraints
List<FieldCardinalityConstraint> getFieldCardinalityConstraints()- Returns:
Listcontaining cardinality constraints for the selected (analysis-specific) fields
-
getResultMappings
Map<String,Object> getResultMappings(String resultsFieldName, FieldCapabilitiesResponse fieldCapabilitiesResponse) Returns fields for which the mappings should be either predefined or copied from source index to destination index.- 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
boolean supportsMissingValues()- Returns:
trueif this analysis supports data frame rows with missing values
-
persistsState
boolean persistsState()- Returns:
trueif this analysis persists state that can later be used to restore from a given point
-
getStateDocIdPrefix
Returns the document id prefix for the analysis state -
getProgressPhases
Returns the progress phases the analysis goes through in order -
inferenceConfig
- Returns:
- the analysis inference config or
nullif inference is not supported
-
supportsInference
boolean supportsInference()- Returns:
trueif this analysis trains a model that can be used for inference
-
getTrainingPercent
default double getTrainingPercent()- Returns:
- the percentage of data to use for training
-