› › ›

API для объяснения конфигурации анализа данных в формате DataFrame

Объясняет конфигурацию анализа данных в формате DataFrame.

Запрос

GET _ml/data_frame/analytics/_explain

POST _ml/data_frame/analytics/_explain

GET _ml/data_frame/analytics/<data_frame_analytics_id>/_explain

POST _ml/data_frame/analytics/<data_frame_analytics_id>/_explain

Предварительные условия

Требуются следующие привилегии:

cluster: monitor_ml (роль machine_learning_user предоставляет эту привилегию)
source indices: read, view_index_metadata

Описание

Этот API предоставляет объяснения конфигурации анализа данных в формате DataFrame, которая уже существует или ещё не создана. Предоставляются следующие объяснения:

какие поля включены или исключены из анализа и почему,
сколько памяти примерно потребуется. Оценка может быть использована при определении подходящего значения параметра model_memory_limit в дальнейшем.

Если у вас есть поля типа объект или поля, исключённые с помощью фильтрации источников, они не включаются в объяснение.

Параметры пути

<data_frame_analytics_id>: (Необязательно, строка) Идентификатор задания анализа данных в формате DataFrame.

Тело запроса

Конфигурация анализа данных в формате DataFrame, как описано в API для создания заданий анализа данных в формате DataFrame. Обратите внимание, что id и dest не требуется предоставлять в контексте этого API.

Тело ответа

API возвращает ответ, содержащий следующее:

field_selection

(массив) Массив объектов, объясняющих выбор для каждого поля, отсортированные по именам полей.

Свойства объектов field_selection

is_included: (Булево) Выбрано ли поле для включения в анализ.
is_required: (Булево) Требуется ли поле.
feature_type: (строка) Тип признака этого поля для анализа. Может быть categorical или numerical.
mapping_types: (строка) Типы отображения поля.
name: (строка) Название поля.
reason: (строка) Причина, по которой поле не выбрано для включения в анализ.

memory_estimation

(объект) Объект, содержащий оценки памяти.

Свойства memory_estimation

expected_memory_with_disk: (строка) Оценка использования памяти при предположении, что переполнение на диск разрешено во время анализа данных в формате DataFrame. expected_memory_with_disk обычно меньше, чем expected_memory_without_disk, так как использование диска позволяет ограничить потребность в оперативной памяти для выполнения анализа данных в формате DataFrame.
expected_memory_without_disk: (строка) Оценка использования памяти при предположении, что весь анализ данных в формате DataFrame должен происходить в оперативной памяти (т.е. без переполнения на диск).

Примеры

resp = client.ml.explain_data_frame_analytics(
    source={
        "index": "houses_sold_last_10_yrs"
    },
    analysis={
        "regression": {
            "dependent_variable": "price"
        }
    },
)
print(resp)

const response = await client.ml.explainDataFrameAnalytics({
  source: {
    index: "houses_sold_last_10_yrs",
  },
  analysis: {
    regression: {
      dependent_variable: "price",
    },
  },
});
console.log(response);

POST _ml/data_frame/analytics/_explain
{
  "source": {
    "index": "houses_sold_last_10_yrs"
  },
  "analysis": {
    "regression": {
      "dependent_variable": "price"
    }
  }
}

API возвращает следующие результаты:

{
  "field_selection": [
    {
      "field": "number_of_bedrooms",
      "mappings_types": ["integer"],
      "is_included": true,
      "is_required": false,
      "feature_type": "numerical"
    },
    {
      "field": "postcode",
      "mappings_types": ["text"],
      "is_included": false,
      "is_required": false,
      "reason": "[postcode.keyword] is preferred because it is aggregatable"
    },
    {
      "field": "postcode.keyword",
      "mappings_types": ["keyword"],
      "is_included": true,
      "is_required": false,
      "feature_type": "categorical"
    },
    {
      "field": "price",
      "mappings_types": ["float"],
      "is_included": true,
      "is_required": true,
      "feature_type": "numerical"
    }
  ],
  "memory_estimation": {
    "expected_memory_without_disk": "128MB",
    "expected_memory_with_disk": "32MB"
  }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/explain-dfanalytics.html