› › ›

API получения обученных моделей

Получает конфигурационную информацию об обученной модели.

Запрос

GET _ml/trained_models/

GET _ml/trained_models/<model_id>

GET _ml/trained_models/_all

GET _ml/trained_models/<model_id1>,<model_id2>

GET _ml/trained_models/<model_id_pattern*>

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

Требуется привилегия кластера monitor_ml. Данная привилегия включена в встроенную роль machine_learning_user.

Описание

Вы можете получить информацию о нескольких обученных моделях в одном запросе API, используя список идентификаторов моделей, разделённых запятыми, или выражение с подстановкой.

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

<model_id>: (Необязательный, строка) Уникальный идентификатор обученной модели или псевдоним модели.

Параметры запроса

allow_no_match

(Необязательный, Булево) Указывает, что делать при запросе:

Содержит подстановочные знаки, и не найдено совпадающих моделей.
Содержит строку _all или не содержит идентификаторов, и нет совпадений.
Содержит подстановочные знаки, и найдены частичные совпадения.

Значение по умолчанию — true, что возвращает пустой массив при отсутствии совпадений и подмножество результатов при частичных совпадениях. Если этот параметр равен false, запрос возвращает код состояния 404 при отсутствии совпадений или частичных совпадениях.

decompress_definition

(Необязательный, Булево) Указывает, должно ли включенное определение модели возвращаться в формате JSON-карты (true) или в пользовательском сжатом формате (false). По умолчанию true.

exclude_generated

(Необязательный, Булево) Указывает, нужно ли удалить определенные поля из конфигурации при получении. Это позволяет конфигурации быть в приемлемом формате для извлечения и последующего добавления в другой кластер. По умолчанию ложь.

from

(Необязательный, целое число) Пропускает указанное количество моделей. Значение по умолчанию — 0.

include

(Необязательный, строка) Разделённая запятыми строка необязательных полей для включения в ответ. Значение по умолчанию пустое, что означает, что необязательные поля не включаются. Допустимые значения:

definition: Включает определение модели.
feature_importance_baseline: Включает базовый показатель важности признаков.
hyperparameters: Включает информацию о гиперпараметрах, используемых для обучения модели. Эта информация состоит из значения, абсолютной и относительной важности гиперпараметра, а также индикатора, был ли он указан пользователем или настроен во время оптимизации гиперпараметров.
total_feature_importance: Включает общую важность признаков для набора данных обучения. Значения базовой и общей важности признаков возвращаются в поле metadata в теле ответа.

size

(Необязательный, целое число) Указывает максимальное количество моделей для получения. Значение по умолчанию — 100.

tags

(Необязательный, строка) Разделённая запятыми строка тегов. Обученная модель может иметь множество тегов или ни одного. При указании возвращаются только обученные модели, содержащие все указанные теги.

Тело ответа

trained_model_configs

(массив) Массив обученных моделей, отсортированных по значению model_id в порядке возрастания.

Свойства обученных моделей

created_by

(строка) Информация о создателе обученной модели.

create_time

(единицы времени) Время создания обученной модели.

default_field_map

(объект) Объект «строка-строка», содержащий карту полей по умолчанию для использования при инференции с моделью. Например, аналитика на основе фреймов данных может обучить модель на определённом многопольном foo.keyword. Затем задача аналитики предоставит запись в карте полей по умолчанию для "foo" : "foo.keyword".

Любая карта полей, описанная в конфигурации инференции, имеет приоритет.

description

(строка) Свободный текст, описывающий обученную модель.

estimated_heap_memory_usage_bytes

(целое число) Оценка использования кучи в байтах для хранения обученной модели в памяти.

estimated_operations

(целое число) Оценка количества операций для использования обученной модели.

inference_config

(объект) Конфигурация по умолчанию для инференции. Это может быть конфигурация regression или classification. Она должна соответствовать базовому типу definition.trained_model's target_type.

Свойства inference_config

classification

(объект) Конфигурация инференции для классификации.

Свойства инференции классификации

num_top_classes: (целое число) Указывает количество прогнозов с лучшими классами для возврата. По умолчанию 0.
num_top_feature_importance_values: (целое число) Указывает максимальное количество значений важности признаков на документ. По умолчанию 0, и вычисление важности признаков не происходит.
prediction_field_type: (строка) Указывает тип прогнозируемого поля для записи. Допустимые значения: string, number, boolean. При предоставлении boolean 1.0 преобразуется в true, а 0.0 — в false.
results_field: (строка) Поле, добавляемое к входным документам для хранения прогноза инференции. По умолчанию predicted_value.
top_classes_results_field: (строка) Поле, в которое записываются лучшие классы. По умолчанию top_classes.

regression

(объект) Конфигурация инференции для регрессии.

Свойства инференции регрессии

num_top_feature_importance_values: (целое число) Указывает максимальное количество значений важности признаков на документ. По умолчанию 0, и вычисление важности признаков не происходит.
results_field: (строка) Поле, добавляемое к входным документам для хранения прогноза инференции. По умолчанию predicted_value.

input

(объект) Имена входных полей для определения модели.

Свойства input

field_names: (строка) Массив имён входных полей для модели.

license_level

(строка) Уровень лицензии обученной модели.

metadata

(объект) Объект, содержащий метаданные об обученной модели. Например, модели, созданные с помощью аналитики фреймов данных, содержат объекты analysis_config и input.

Свойства метаданных

feature_importance_baseline

(объект) Объект, содержащий базовый уровень для значений важности признаков. Для регрессионного анализа — одно значение. Для классификационного анализа — значение для каждого класса.

hyperparameters

(массив) Список доступных гиперпараметров, оптимизированных в процессе fine_parameter_tuning, а также указанных пользователем.

Свойства гиперпараметров

absolute_importance: (двойное число) Положительное число, показывающее, насколько параметр влияет на вариативность функции потерь. Для гиперпараметров с значениями, не заданными пользователем, а настроенными при оптимизации гиперпараметров.
max_trees: (целое число) Максимальное количество деревьев решений в лесу. Максимальное значение — 2000. По умолчанию вычисляется при оптимизации гиперпараметров.
name: (строка) Название гиперпараметра.
relative_importance: (двойное число) Число от 0 до 1, показывающее долю влияния на вариативность функции потерь среди всех настроенных гиперпараметров. Для гиперпараметров с значениями, не заданными пользователем, а настроенными при оптимизации гиперпараметров.
supplied: (логическое значение) Указывает, задан ли гиперпараметр пользователем (true) или оптимизирован (false).
value: (двойное число) Значение гиперпараметра, оптимизированного или заданного пользователем.

total_feature_importance

(массив) Массив общей важности признака для каждого признака, используемого из набора обучающих данных. Этот массив объектов возвращается, если аналитика фреймов данных обучила модель, и запрос включает total_feature_importance в параметре запроса include.

Свойства общей важности признаков

feature_name

(строка) Признак, для которого была рассчитана важность.

importance

(объект) Совокупность статистических данных о важности признаков, связанных с обучающим набором данных для этого конкретного признака.

Свойства важности признака

mean_magnitude: (двойное число) Средняя величина этого признака по всем обучающим данным. Это среднее абсолютных значений важности для этого признака.
max: (целое число) Максимальное значение важности признака по всем обучающим данным для этого признака.
min: (целое число) Минимальное значение важности признака по всем обучающим данным для этого признака.

classes

(массив) Если обученная модель — модель классификации, статистика важности признаков собирается по каждому значению целевого класса.

Свойства важности признака по классам

class_name

(строка) Значение целевого класса. Может быть строкой, булевым значением или числом.

importance

Свойства важности признака

mean_magnitude: (двойное число) Средняя величина этого признака по всем обучающим данным. Это среднее абсолютных значений важности для этого признака.
max: (целое число) Максимальное значение важности признака по всем обучающим данным для этого признака.
min: (целое число) Минимальное значение важности признака по всем обучающим данным для этого признака.

model_id

(строка) Идентификатор обученной модели.

tags

(строка) Строка тегов, разделённых запятыми. Обученная модель может иметь множество тегов или ни одного.

version

(строка) Версия Elasticsearch, в которой была создана обученная модель.

Коды ответов

400: Если include_model_definition является true, этот код указывает, что более одного модели соответствуют шаблону ID.
404 (Отсутствующие ресурсы): Если allow_no_match является false, этот код указывает, что нет ресурсов, которые соответствуют запросу, или только частичные совпадения для запроса.

Примеры

В следующем примере извлекается информация о конфигурации для всех обученных моделей:

GET _ml/trained_models/

© 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/7.17/get-trained-models.html