[ML] Update doc link, tick formatter, and baseline api for generic results fields

Author: qn895

x-pack/plugins/ml/common/constants/data_frame_analytics.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export const DEFAULT_RESULTS_FIELD = 'ml';

x-pack/plugins/ml/public/application/components/data_grid/data_grid.tsx

@@ -31,7 +31,7 @@ import { euiDataGridStyle, euiDataGridToolbarSettings } from './common';
 import { UseIndexDataReturnType } from './types';
 import { DecisionPathPopover } from './feature_importance/decision_path_popover';
 import { TopClasses } from '../../../../common/types/feature_importance';
-import { DEFAULT_RESULTS_FIELD } from '../../data_frame_analytics/common/constants';
+import { DEFAULT_RESULTS_FIELD } from '../../../../common/constants/data_frame_analytics';
 
 // TODO Fix row hovering + bar highlighting
 // import { hoveredRow$ } from './column_chart';

x-pack/plugins/ml/public/application/components/data_grid/feature_importance/decision_path_chart.tsx

@@ -105,7 +105,9 @@ export const DecisionPathChart = ({
     ],
     [baseline]
   );
-  const tickFormatter = useCallback((d) => Number(d).toPrecision(NUM_PRECISION), []);
+  // guarantee up to num_precision significant digits
+  // without having it in scientific notation
+  const tickFormatter = useCallback((d) => Number(d.toPrecision(NUM_PRECISION)).toString(), []);
 
   return (
     <Chart

x-pack/plugins/ml/public/application/components/data_grid/feature_importance/decision_path_popover.tsx

@@ -12,6 +12,7 @@ import { DecisionPathJSONViewer } from './decision_path_json_viewer';
 import { FeatureImportance, TopClasses } from '../../../../../common/types/feature_importance';
 import { ANALYSIS_CONFIG_TYPE } from '../../../data_frame_analytics/common';
 import { ClassificationDecisionPath } from './decision_path_classification';
+import { useMlKibana } from '../../../contexts/kibana';
 
 interface DecisionPathPopoverProps {
   featureImportance: FeatureImportance[];
@@ -40,6 +41,10 @@ export const DecisionPathPopover: FC<DecisionPathPopoverProps> = ({
   predictionFieldName,
 }) => {
   const [selectedTabId, setSelectedTabId] = useState(DECISION_PATH_TABS.CHART);
+  const {
+    services: { docLinks },
+  } = useMlKibana();
+  const { ELASTIC_WEBSITE_URL, DOC_LINK_VERSION } = docLinks;
 
   if (featureImportance.length < 2) {
     return <DecisionPathJSONViewer featureImportance={featureImportance} />;
@@ -91,7 +96,7 @@ export const DecisionPathPopover: FC<DecisionPathPopoverProps> = ({
                 predictionFieldName,
                 linkedFeatureImportanceValues: (
                   <EuiLink
-                    href="https://www.elastic.co/guide/en/machine-learning/7.8/ml-feature-importance.html"
+                    href={`${ELASTIC_WEBSITE_URL}guide/en/machine-learning/${DOC_LINK_VERSION}/ml-feature-importance.html`}
                     target="_blank"
                   >
                     <FormattedMessage

x-pack/plugins/ml/public/application/data_frame_analytics/common/constants.ts

@@ -3,8 +3,6 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-
-export const DEFAULT_RESULTS_FIELD = 'ml';
 export const FEATURE_IMPORTANCE = 'feature_importance';
 export const FEATURE_INFLUENCE = 'feature_influence';
 export const TOP_CLASSES = 'top_classes';

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_results_table/use_exploration_results.ts

@@ -30,11 +30,8 @@ import {
   getPredictionFieldName,
   getDefaultPredictionFieldName,
 } from '../../../../../../../common/util/analytics_utils';
-import {
-  DEFAULT_RESULTS_FIELD,
-  FEATURE_IMPORTANCE,
-  TOP_CLASSES,
-} from '../../../../common/constants';
+import { FEATURE_IMPORTANCE, TOP_CLASSES } from '../../../../common/constants';
+import { DEFAULT_RESULTS_FIELD } from '../../../../../../../common/constants/data_frame_analytics';
 import { sortExplorationResultsFields, ML__ID_COPY } from '../../../../common/fields';
 import { isRegressionAnalysis } from '../../../../common/analytics';
 import { extractErrorMessage } from '../../../../../../../common/util/errors';

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/outlier_exploration/use_outlier_data.ts

@@ -29,7 +29,8 @@ import { SavedSearchQuery } from '../../../../../contexts/ml';
 import { getToastNotifications } from '../../../../../util/dependency_cache';
 
 import { getIndexData, getIndexFields, DataFrameAnalyticsConfig } from '../../../../common';
-import { DEFAULT_RESULTS_FIELD, FEATURE_INFLUENCE } from '../../../../common/constants';
+import { FEATURE_INFLUENCE } from '../../../../common/constants';
+import { DEFAULT_RESULTS_FIELD } from '../../../../../../../common/constants/data_frame_analytics';
 import { sortExplorationResultsFields, ML__ID_COPY } from '../../../../common/fields';
 
 import { getFeatureCount, getOutlierScoreFieldName } from './common';

x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_management/components/action_clone/clone_action_name.tsx

@@ -12,7 +12,7 @@ import { IIndexPattern } from 'src/plugins/data/common';
 import { DeepReadonly } from '../../../../../../../common/types/common';
 import { DataFrameAnalyticsConfig, isOutlierAnalysis } from '../../../../common';
 import { isClassificationAnalysis, isRegressionAnalysis } from '../../../../common/analytics';
-import { DEFAULT_RESULTS_FIELD } from '../../../../common/constants';
+import { DEFAULT_RESULTS_FIELD } from '../../../../../../../common/constants/data_frame_analytics';
 import { useMlKibana, useNavigateToPath } from '../../../../../contexts/kibana';
 import { DEFAULT_NUM_TOP_FEATURE_IMPORTANCE_VALUES } from '../../hooks/use_create_analytics_form';
 import { State } from '../../hooks/use_create_analytics_form/state';

x-pack/plugins/ml/server/models/data_frame_analytics/feature_importance.ts

@@ -5,8 +5,12 @@
  */
 
 import { IScopedClusterClient } from 'kibana/server';
-import { getPredictionFieldName, isRegressionAnalysis } from '../../../common/util/analytics_utils';
-
+import {
+  getDefaultPredictionFieldName,
+  getPredictionFieldName,
+  isRegressionAnalysis,
+} from '../../../common/util/analytics_utils';
+import { DEFAULT_RESULTS_FIELD } from '../../../common/constants/data_frame_analytics';
 // Obtains data for the data frame analytics feature importance functionalities
 // such as baseline, decision paths, or importance summary.
 export function analyticsFeatureImportanceProvider({
@@ -20,7 +24,13 @@ export function analyticsFeatureImportanceProvider({
     const jobConfig = body.data_frame_analytics[0];
     if (!isRegressionAnalysis) return undefined;
     const destinationIndex = jobConfig.dest.index;
-    const predictionField = getPredictionFieldName(jobConfig.analysis);
+    const predictionFieldName = getPredictionFieldName(jobConfig.analysis);
+    const mlResultsField = jobConfig.dest?.results_field ?? DEFAULT_RESULTS_FIELD;
+    const predictedField = `${mlResultsField}.${
+      predictionFieldName ? predictionFieldName : getDefaultPredictionFieldName(jobConfig.analysis)
+    }`;
+    const isTrainingField = `${mlResultsField}.is_training`;
+
     const params = {
       index: destinationIndex,
       size: 0,
@@ -30,7 +40,7 @@ export function analyticsFeatureImportanceProvider({
             filter: [
               {
                 term: {
-                  'ml.is_training': true,
+                  [isTrainingField]: true,
                 },
               },
             ],
@@ -39,7 +49,7 @@ export function analyticsFeatureImportanceProvider({
         aggs: {
           featureImportanceBaseline: {
             avg: {
-              field: `ml.${predictionField}`,
+              field: predictedField,
             },
           },
         },