机器学习（ML）
- class elasticsearch.client.MlClient
To use this client, access
client.mlfrom anElasticsearchclient. For example:from elasticsearch import Elasticsearch # Create the client instance client = Elasticsearch(...) # Use the ml client client.ml.<method>(...)
- clear_trained_model_deployment_cache(*, model_id, error_trace=None, filter_path=None, human=None, pretty=None)
清除训练模型部署缓存。
缓存将在分配了训练模型的所有节点上被清除。 训练模型部署可能启用了推理缓存。 当请求由各个分配节点处理时，它们的响应可能会缓存在该节点上。 调用此API可在不重启部署的情况下清除缓存。
- close_job(*, job_id, allow_no_match=None, error_trace=None, filter_path=None, force=None, human=None, pretty=None, timeout=None, body=None)
关闭异常检测任务。
任务在其生命周期内可以被多次打开和关闭。关闭的任务无法接收数据或执行分析操作，但仍可浏览和导航结果。 关闭任务时，它会运行一些维护任务，如修剪模型历史记录、刷新缓冲区、计算最终结果和持久化模型快照。根据任务大小，关闭可能需要几分钟时间，重新打开也需要相同时间。关闭后，任务对集群的开销最小，仅需维护其元数据。因此最佳实践是关闭不再需要处理数据的任务。 如果要关闭其数据馈送正在运行的异常检测任务，请求会首先尝试停止数据馈送。此行为等同于使用与关闭任务请求相同的超时和强制参数调用停止数据馈送API。 当具有指定结束日期的数据馈送停止时，它会自动关闭其关联的任务。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job
- Parameters:
job_id (str) – 异常检测任务的标识符。可以是任务标识符、 组名或通配符表达式。您可以通过使用组名、逗号分隔的 任务列表或通配符表达式，在单个API请求中关闭多个异常检测 任务。您可以通过使用`_all` 或将`*`指定为任务标识符来关闭所有任务。
allow_no_match (bool | None) – 参考`allow_no_match`查询 参数的描述。
force (bool | None) – 参考`force`查询参数的描述。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 参考`timeout`查询参数的描述。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- delete_calendar(*, calendar_id, error_trace=None, filter_path=None, human=None, pretty=None)
删除日历。
从日历中移除所有预定事件，然后删除日历。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar
- delete_calendar_event(*, calendar_id, event_id, error_trace=None, filter_path=None, human=None, pretty=None)
从日历中删除事件。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event
- delete_calendar_job(*, calendar_id, job_id, error_trace=None, filter_path=None, human=None, pretty=None)
从日历中删除异常任务。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job
- delete_data_frame_analytics(*, id, error_trace=None, filter_path=None, force=None, human=None, pretty=None, timeout=None)
删除一个数据框分析任务。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics
- Parameters:
- Return type:
- delete_datafeed(*, datafeed_id, error_trace=None, filter_path=None, force=None, human=None, pretty=None)
删除一个数据馈送。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed
- delete_expired_data(*, job_id=None, error_trace=None, filter_path=None, human=None, pretty=None, requests_per_second=None, timeout=None, body=None)
删除过期的机器学习数据。
删除所有超过保留期限的任务结果、模型快照和预测数据。与任何任务无关的机器学习状态文档也会被删除。 您可以通过使用任务标识符、组名、逗号分隔的任务列表或通配符表达式来限制请求范围。 您可以通过使用
_all、指定*作为<job_id>或省略<job_id>来删除所有异常检测任务的过期数据。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data
- delete_filter(*, filter_id, error_trace=None, filter_path=None, human=None, pretty=None)
删除一个过滤器。
如果有异常检测任务引用了该过滤器，则无法删除。必须先更新或删除任务才能删除过滤器。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter
- delete_forecast(*, job_id, forecast_id=None, allow_no_forecasts=None, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None)
从任务中删除预测。
默认情况下，预测数据会保留14天。您可以通过预测任务API中的
expires_in参数 指定不同的保留期限。删除预测API允许您在预测过期前删除一个或多个预测。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast
- Parameters:
job_id (str) – 异常检测任务的标识符。
forecast_id (str | None) – 逗号分隔的预测标识符列表。如果未指定此可选参数或指定 _all 或 *， API将删除任务中的所有预测。
allow_no_forecasts (bool | None) – 指定当没有预测时是否报错。特别是，如果此参数设为 false 且 任务没有关联的预测，尝试删除所有预测将返回错误。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 指定等待删除操作完成的超时时间。超过此时限，API将失败并返回错误。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- delete_job(*, job_id, delete_user_annotations=None, error_trace=None, filter_path=None, force=None, human=None, pretty=None, wait_for_completion=None)
删除异常检测任务。
所有任务配置、模型状态和结果都将被删除。 目前无法使用通配符或逗号分隔列表删除多个任务。如果要删除具有数据馈送的任务， 请求会首先尝试删除数据馈送。此行为等同于使用与删除任务请求相同的超时和强制参数 调用删除数据馈送API。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job
- Parameters:
- Return type:
- delete_model_snapshot(*, job_id, snapshot_id, error_trace=None, filter_path=None, human=None, pretty=None)
删除模型快照。
无法删除活动的模型快照。要删除该快照，请先恢复到其他快照。 要识别活动的模型快照，请参考获取任务API结果中的
model_snapshot_id。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot
- delete_trained_model(*, model_id, error_trace=None, filter_path=None, force=None, human=None, pretty=None, timeout=None)
删除未被引用的训练模型。
该请求删除未被摄取管道引用的训练推理模型。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model
- Parameters:
- Return type:
- delete_trained_model_alias(*, model_id, model_alias, error_trace=None, filter_path=None, human=None, pretty=None)
删除训练模型别名。
此API删除引用训练模型的现有模型别名。如果模型别名缺失或引用的是 与
model_id标识的模型不同的模型，此API将返回错误。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias
- estimate_model_memory(*, analysis_config=None, error_trace=None, filter_path=None, human=None, max_bucket_cardinality=None, overall_cardinality=None, pretty=None, body=None)
估算任务模型内存使用量。
对异常检测任务模型的内存使用量进行估算。估算基于任务的 分析配置详情及其引用字段的基数估计。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory
- Parameters:
analysis_config (Mapping[str, Any] | None) – 有关可在此API请求体的`analysis_config`组件中 指定的属性列表。
max_bucket_cardinality (Mapping[str, int] | None) – 对影响者字段在任务分析数据的时间段内 单个桶中观察到的最高基数的估计。要获得良好答案，必须为所有影响者字段提供值。 为未列为`influencers`的字段提供值对估算没有影响。
overall_cardinality (Mapping[str, int] | None) – 对任务分析数据的整个时间段内字段观察到的 基数的估计。要获得良好答案，必须为任何检测器的`by_field_name`、 over_field_name`和`partition_field_name`中引用的字段提供值。 为其他字段提供值对估算没有影响。如果检测器没有`by_field_name、 over_field_name`或`partition_field_name，可以省略此参数。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- evaluate_data_frame(*, evaluation=None, index=None, error_trace=None, filter_path=None, human=None, pretty=None, query=None, body=None)
评估数据框分析结果。
该API封装了针对各类机器学习特征的常用评估指标。专为数据框分析创建的索引设计。评估需要同时存在真实值字段和分析结果字段。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame
- Parameters:
- Return type:
- explain_data_frame_analytics(*, id=None, allow_lazy_start=None, analysis=None, analyzed_fields=None, description=None, dest=None, error_trace=None, filter_path=None, human=None, max_num_threads=None, model_memory_limit=None, pretty=None, source=None, body=None)
解释数据框分析配置。
该API为已存在或尚未创建的数据框分析配置提供解释说明。包含以下内容：
- 哪些字段被包含或排除在分析中及其原因
- 预估所需内存量。该估算值可用于后续确定model_memory_limit设置的适当值。 若存在对象字段或通过源过滤排除的字段，则不会包含在解释中。
- Parameters:
id (str | None) – 数据框分析任务的标识符。可包含小写字母数字字符（a-z和0-9）、连字符和下划线。 必须以字母数字字符开头和结尾。
allow_lazy_start (bool | None) – 指定当机器学习节点容量不足时是否允许延迟启动任务。
analysis (Mapping[str, Any] | None) – 分析配置，包含执行分类、异常检测或回归分析的必要信息。
analyzed_fields (Mapping[str, Any] | None) – 通过包含/排除模式选择分析字段。排除模式最后应用，因此具有更高优先级。 若同一字段同时出现在包含和排除中，则该字段不会被分析。
description (str | None) – 任务描述。
max_num_threads (int | None) – 分析使用的最大线程数。增加线程可能减少分析时间但消耗更多CPU。 注意：除分析本身外，进程可能使用额外线程进行其他操作。
model_memory_limit (str | None) – 允许用于分析处理的最大内存资源近似值。若elasticsearch.yml中 设置了xpack.ml.max_model_memory_limit，当尝试创建超过该限制的任务时会报错。
source (Mapping[str, Any] | None) – 分析数据源的配置。必须指定索引，可选指定查询和_source。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- flush_job(*, job_id, advance_time=None, calc_interim=None, end=None, error_trace=None, filter_path=None, human=None, pretty=None, skip_time=None, start=None, body=None)
强制处理缓冲数据。 刷新任务API仅适用于使用post data API发送分析数据的情况。根据缓冲区内容， 可能还会计算新结果。刷新和关闭操作类似，但若预期发送更多数据分析，刷新效率更高。 刷新后任务保持开启状态可继续分析数据。关闭操作还会修剪模型状态并持久化到磁盘， 再次分析数据前需重新开启任务。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job
- forecast(*, job_id, duration=None, error_trace=None, expires_in=None, filter_path=None, human=None, max_model_memory=None, pretty=None, body=None)
预测时间序列未来行为。
不支持对执行群体分析的任务进行预测；若尝试为配置中包含
over_field_name的任务创建预测将报错。预测基于历史数据推断未来行为。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast
- Parameters:
job_id (str) – 异常检测任务标识符。创建预测时任务必须处于开启状态，否则报错。
duration (str | Literal[-1] | ~typing.Literal[0] | None) – 参见`duration`查询参数说明。
expires_in (str | Literal[-1] | ~typing.Literal[0] | None) – 参见`expires_in`查询参数说明。
max_model_memory (str | None) – 参见`max_model_memory`查询参数说明。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_buckets(*, job_id, timestamp=None, anomaly_score=None, desc=None, end=None, error_trace=None, exclude_interim=None, expand=None, filter_path=None, from_=None, human=None, page=None, pretty=None, size=None, sort=None, start=None, body=None)
获取按桶分组的异常检测结果。 该API按时间顺序展示以桶为分组的记录视图。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets
- Parameters:
job_id (str) – 异常检测任务标识符。
anomaly_score (float | None) – 参见`anomaly_score`查询参数说明。
desc (bool | None) – 参见`desc`查询参数说明。
exclude_interim (bool | None) – 参见`exclude_interim`查询参数说明。
expand (bool | None) – 参见`expand`查询参数说明。
from – 跳过指定数量的桶。
size (int | None) – 指定获取的最大桶数。
sort (str | None) – 参见`sort`查询参数说明。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_calendar_events(*, calendar_id, end=None, error_trace=None, filter_path=None, from_=None, human=None, job_id=None, pretty=None, size=None, start=None)
获取日历中的事件信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events
- Parameters:
calendar_id (str) – 唯一标识日历的字符串。可以通过使用逗号分隔的ID列表或通配符表达式获取多个日历的信息。使用`_all`或`*`或省略日历标识符可获取所有日历的信息。
from – 跳过指定数量的事件。
job_id (str | None) – 指定获取特定异常检测作业标识符或作业组的事件。必须与`_all`或`*`的日历标识符一起使用。
size (int | None) – 指定要获取的最大事件数量。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_calendars(*, calendar_id=None, error_trace=None, filter_path=None, from_=None, human=None, page=None, pretty=None, size=None, body=None)
获取日历配置信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars
- get_categories(*, job_id, category_id=None, error_trace=None, filter_path=None, from_=None, human=None, page=None, partition_field_value=None, pretty=None, size=None, body=None)
获取类别的异常检测作业结果。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories
- Parameters:
job_id (str) – 异常检测作业的标识符。
category_id (str | None) – 类别的标识符，在作业中唯一。如果既不指定类别ID也不指定partition_field_value，则API返回所有类别的信息。如果仅指定partition_field_value，则返回指定分区的所有类别信息。
from – 跳过指定数量的类别。
page (Mapping[str, Any] | None) – 配置分页。此参数具有`from`和`size`属性。
partition_field_value (str | None) – 仅返回指定分区的类别。
size (int | None) – 指定要获取的最大类别数量。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_data_frame_analytics(*, id=None, allow_no_match=None, error_trace=None, exclude_generated=None, filter_path=None, from_=None, human=None, pretty=None, size=None)
获取数据框分析作业配置信息。 可以通过使用逗号分隔的数据框分析作业列表或通配符表达式，在单个API请求中获取多个数据框分析作业的信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics
- Parameters:
id (str | None) – 数据框分析作业的标识符。如果不指定此选项，API将返回前一百个数据框分析作业的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式且没有匹配的数据框分析作业。2.包含`_all`字符串或无标识符且没有匹配项。3.包含通配符表达式且只有部分匹配项。默认值在没有匹配项时返回空data_frame_analytics数组，在部分匹配时返回结果子集。如果此参数为`false`，则请求在没有匹配项或只有部分匹配项时返回404状态码。
exclude_generated (bool | None) – 指示在检索时是否应从配置中移除某些字段。这允许配置以可接受的格式被检索，然后添加到另一个集群。
from – 跳过指定数量的数据框分析作业。
size (int | None) – 指定要获取的最大数据框分析作业数量。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_data_frame_analytics_stats(*, id=None, allow_no_match=None, error_trace=None, filter_path=None, from_=None, human=None, pretty=None, size=None, verbose=None)
获取数据框分析作业统计信息。
- Parameters:
id (str | None) – 数据框分析作业的标识符。如果不指定此选项，API将返回前一百个数据框分析作业的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式且没有匹配的数据框分析作业。2.包含`_all`字符串或无标识符且没有匹配项。3.包含通配符表达式且只有部分匹配项。默认值在没有匹配项时返回空data_frame_analytics数组，在部分匹配时返回结果子集。如果此参数为`false`，则请求在没有匹配项或只有部分匹配项时返回404状态码。
from – 跳过指定数量的数据框分析作业。
size (int | None) – 指定要获取的最大数据框分析作业数量。
verbose (bool | None) – 定义统计响应是否应详细。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_datafeed_stats(*, datafeed_id=None, allow_no_match=None, error_trace=None, filter_path=None, human=None, pretty=None)
获取数据馈送统计信息。 您可以通过使用逗号分隔的数据馈送列表或通配符表达式，在单个API请求中获取多个数据馈送的统计信息。 您可以通过使用
_all、将*指定为<feed_id>或省略<feed_id>来获取所有数据馈送的统计信息。 如果数据馈送已停止，您将仅收到datafeed_id和state信息。 此API最多返回10,000个数据馈送。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats
- Parameters:
datafeed_id (str | Sequence[str] | None) – 数据馈送的标识符。可以是数据馈送标识符或通配符表达式。 如果未指定这些选项之一，API将返回所有数据馈送的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式但没有匹配的数据馈送。 2.包含`_all`字符串或无标识符且没有匹配项。3.包含通配符表达式但只有部分匹配。 默认值为`true`，当没有匹配项时返回空的`datafeeds`数组，当有部分匹配时返回结果的子集。 如果此参数为`false`，当没有匹配或只有部分匹配时，请求将返回`404`状态码。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_datafeeds(*, datafeed_id=None, allow_no_match=None, error_trace=None, exclude_generated=None, filter_path=None, human=None, pretty=None)
获取数据馈送配置信息。 您可以通过使用逗号分隔的数据馈送列表或通配符表达式，在单个API请求中获取多个数据馈送的信息。 您可以通过使用
_all、将*指定为<feed_id>或省略<feed_id>来获取所有数据馈送的信息。 此API最多返回10,000个数据馈送。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds
- Parameters:
datafeed_id (str | Sequence[str] | None) – 数据馈送的标识符。可以是数据馈送标识符或通配符表达式。 如果未指定这些选项之一，API将返回所有数据馈送的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式但没有匹配的数据馈送。 2.包含`_all`字符串或无标识符且没有匹配项。3.包含通配符表达式但只有部分匹配。 默认值为`true`，当没有匹配项时返回空的`datafeeds`数组，当有部分匹配时返回结果的子集。 如果此参数为`false`，当没有匹配或只有部分匹配时，请求将返回`404`状态码。
exclude_generated (bool | None) – 指示在检索时是否应从配置中移除某些字段。 这允许配置以可接受的格式被检索，然后添加到另一个集群。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_filters(*, filter_id=None, error_trace=None, filter_path=None, from_=None, human=None, pretty=None, size=None)
获取过滤器。 您可以获取单个过滤器或所有过滤器。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters
- get_influencers(*, job_id, desc=None, end=None, error_trace=None, exclude_interim=None, filter_path=None, from_=None, human=None, influencer_score=None, page=None, pretty=None, size=None, sort=None, start=None, body=None)
获取异常检测作业的影响者结果。 影响者是导致或应对异常负责的实体。 只有在作业配置中指定了
influencer_field_name时，才能获取影响者结果。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers
- Parameters:
job_id (str) – 异常检测作业的标识符。
desc (bool | None) – 如果为true，则结果按降序排序。
end (str | Any | None) – 返回时间戳早于此时间的影响者。默认值表示未设置，结果不限于特定时间戳。
exclude_interim (bool | None) – 如果为true，则输出排除临时结果。默认情况下，包括临时结果。
from – 跳过指定数量的影响者。
influencer_score (float | None) – 返回异常分数大于或等于此值的影响者。
page (Mapping[str, Any] | None) – 配置分页。此参数具有`from`和`size`属性。
size (int | None) – 指定要获取的影响者的最大数量。
sort (str | None) – 指定请求的影响者的排序字段。默认情况下，影响者按`influencer_score`值排序。
start (str | Any | None) – 返回时间戳晚于此时间的影响者。默认值表示未设置，结果不限于特定时间戳。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_job_stats(*, job_id=None, allow_no_match=None, error_trace=None, filter_path=None, human=None, pretty=None)
获取异常检测作业统计信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats
- Parameters:
job_id (str | None) – 异常检测作业的标识符。可以是作业标识符、组名、逗号分隔的作业列表或通配符表达式。 如果未指定这些选项之一，API将返回所有异常检测作业的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式但没有匹配的作业。 2.包含_all字符串或无标识符且没有匹配项。3.包含通配符表达式但只有部分匹配。 如果为`true`，当没有匹配项时API返回空的`jobs`数组，当有部分匹配时返回结果的子集。 如果为`false`，当没有匹配或只有部分匹配时，API返回`404`状态码。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_jobs(*, job_id=None, allow_no_match=None, error_trace=None, exclude_generated=None, filter_path=None, human=None, pretty=None)
获取异常检测作业的配置信息。 您可以通过使用组名、逗号分隔的作业列表或通配符表达式，在单个API请求中获取多个异常检测作业的信息。 您可以通过使用
_all、指定*作为<job_id>或省略<job_id>来获取所有异常检测作业的信息。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs
- Parameters:
job_id (str | Sequence[str] | None) – 异常检测作业的标识符。可以是作业标识符、组名或通配符表达式。如果未指定这些选项之一，则API返回所有异常检测作业的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式但没有匹配的作业 2.包含_all字符串或无标识符且没有匹配项 3.包含通配符表达式且只有部分匹配。默认值为`true`，当没有匹配时返回空的`jobs`数组，当有部分匹配时返回结果子集。如果此参数为`false`，则当没有匹配或只有部分匹配时，请求返回`404`状态码。
exclude_generated (bool | None) – 指示在检索时是否应从配置中移除某些字段。这允许配置以可接受的格式被检索，然后添加到另一个集群。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_memory_stats(*, node_id=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
获取机器学习内存使用信息。 获取有关机器学习作业和训练模型如何在每个节点上使用内存的信息，包括JVM堆内和JVM外的原生内存使用情况。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats
- Parameters:
node_id (str | None) – 集群中特定节点的名称。例如`nodeId1,nodeId2`或`ml:true`
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接到主节点的时间。如果在超时到期前未收到响应，则请求失败并返回错误。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时间。如果在超时到期前未收到响应，则请求失败并返回错误。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_model_snapshot_upgrade_stats(*, job_id, snapshot_id, allow_no_match=None, error_trace=None, filter_path=None, human=None, pretty=None)
获取异常检测作业模型快照升级使用信息。
- Parameters:
job_id (str) – 异常检测作业的标识符。
snapshot_id (str) – 唯一标识模型快照的数字字符串。您可以使用逗号分隔的列表或通配符表达式获取多个快照的信息。您可以通过使用`_all`、指定`*`作为快照ID或省略快照ID来获取所有快照。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：-包含通配符表达式但没有匹配的作业 -包含_all字符串或无标识符且没有匹配项 -包含通配符表达式且只有部分匹配。默认值为true，当没有匹配时返回空的jobs数组，当有部分匹配时返回结果子集。如果此参数为false，则当没有匹配或只有部分匹配时，请求返回404状态码。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_model_snapshots(*, job_id, snapshot_id=None, desc=None, end=None, error_trace=None, filter_path=None, from_=None, human=None, page=None, pretty=None, size=None, sort=None, start=None, body=None)
获取模型快照信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots
- Parameters:
job_id (str) – 异常检测作业的标识符。
snapshot_id (str | None) – 唯一标识模型快照的数字字符串。您可以使用逗号分隔的列表或通配符表达式获取多个快照的信息。您可以通过使用`_all`、指定`*`作为快照ID或省略快照ID来获取所有快照。
desc (bool | None) – 请参考`desc`查询参数的描述。
from – 跳过指定数量的快照。
size (int | None) – 指定要获取的最大快照数。
sort (str | None) – 请参考`sort`查询参数的描述。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_overall_buckets(*, job_id, allow_no_match=None, bucket_span=None, end=None, error_trace=None, exclude_interim=None, filter_path=None, human=None, overall_score=None, pretty=None, start=None, top_n=None, body=None)
获取总体桶结果。
检索汇总多个异常检测作业桶结果的总体桶结果。
overall_score是通过组合总体桶跨度内所有桶的分数来计算的。首先，计算总体桶中每个异常检测作业的最大anomaly_score。然后对这些分数取top_n进行平均，得到overall_score。这意味着您可以微调overall_score，使其对同时检测异常的作业数量更敏感或更不敏感。例如，如果将top_n设置为1，则overall_score是总体桶中的最大桶分数。或者，如果将top_n设置为作业数量，则只有当所有作业在该总体桶中检测到异常时，overall_score才会很高。如果设置了bucket_span参数(大于其默认值)，则overall_score是跨度等于作业最大桶跨度的总体桶的最大overall_score。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets
- Parameters:
job_id (str) – 异常检测作业的标识符。可以是作业标识符、组名、逗号分隔的作业或组列表，或通配符表达式。您可以通过使用`_all`或指定`*`作为`<job_id>`来汇总所有异常检测作业的桶结果。
allow_no_match (bool | None) – 请参考`allow_no_match`查询参数的描述。
bucket_span (str | Literal[-1] | ~typing.Literal[0] | None) – 请参考`bucket_span`查询参数的描述。
exclude_interim (bool | None) – 请参考`exclude_interim`查询参数的描述。
overall_score (float | str | None) – 请参考`overall_score`查询参数的描述。
top_n (int | None) – 请参考`top_n`查询参数的描述。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_records(*, job_id, desc=None, end=None, error_trace=None, exclude_interim=None, filter_path=None, from_=None, human=None, page=None, pretty=None, record_score=None, size=None, sort=None, start=None, body=None)
获取异常检测任务的异常记录。 记录包含详细的分析结果，描述了基于检测器配置在输入数据中识别出的异常活动。 根据输入数据的特征和大小，可能会有许多异常记录。实际上，记录数量通常多到无法手动处理。 因此机器学习功能会对异常记录进行复杂聚合，将其分桶处理。 记录结果的数量取决于每个桶中发现的异常数量，这与建模的时间序列数量和检测器数量相关。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records
- Parameters:
job_id (str) – 异常检测任务的标识符。
desc (bool | None) – 参见 desc 查询参数的描述。
exclude_interim (bool | None) – 参见 exclude_interim 查询参数的描述。
from – 跳过指定数量的记录。
record_score (float | None) – 参见 record_score 查询参数的描述。
size (int | None) – 指定要获取的最大记录数。
sort (str | None) – 参见 sort 查询参数的描述。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_trained_models(*, model_id=None, allow_no_match=None, decompress_definition=None, error_trace=None, exclude_generated=None, filter_path=None, from_=None, human=None, include=None, pretty=None, size=None, tags=None)
获取训练模型的配置信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models
- Parameters:
model_id (str | Sequence[str] | None) – 训练模型的唯一标识符或模型别名。 可以通过逗号分隔的模型ID列表或通配符表达式，在单个API请求中获取多个训练模型的信息。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式： - 包含通配符表达式但没有匹配的模型 - 包含 _all 字符串或无标识符且没有匹配项 - 包含通配符表达式但只有部分匹配 如果为 true，当没有匹配项时返回空数组，当有部分匹配时返回结果子集。
decompress_definition (bool | None) – 指定返回的模型定义是否应作为JSON映射(true)还是自定义压缩格式(false)。
exclude_generated (bool | None) – 指示在检索时是否应从配置中移除某些字段。 这允许配置以可接受的格式被检索，然后添加到另一个集群。
from – 跳过指定数量的模型。
include (str | Literal['definition', 'definition_status', 'feature_importance_baseline', 'hyperparameters', 'total_feature_importance'] | None) – 逗号分隔的可选字段字符串，用于包含在响应体中。
size (int | None) – 指定要获取的最大模型数。
tags (str | Sequence[str] | None) – 逗号分隔的标签字符串。训练模型可以有许多标签或没有标签。 当提供时，只返回包含所有提供标签的训练模型。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_trained_models_stats(*, model_id=None, allow_no_match=None, error_trace=None, filter_path=None, from_=None, human=None, pretty=None, size=None)
获取训练模型的使用信息。 可以通过逗号分隔的模型ID列表或通配符表达式，在单个API请求中获取多个训练模型的使用信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats
- Parameters:
model_id (str | Sequence[str] | None) – 训练模型的唯一标识符或模型别名。 可以是逗号分隔的列表或通配符表达式。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式： - 包含通配符表达式但没有匹配的模型 - 包含 _all 字符串或无标识符且没有匹配项 - 包含通配符表达式但只有部分匹配 如果为 true，当没有匹配项时返回空数组，当有部分匹配时返回结果子集。
from – 跳过指定数量的模型。
size (int | None) – 指定要获取的最大模型数。
error_trace (bool | None)
from_ (int | None)
human (bool | None)
pretty (bool | None)
- Return type:
- infer_trained_model(*, model_id, docs=None, error_trace=None, filter_path=None, human=None, inference_config=None, pretty=None, timeout=None, body=None)
评估训练模型。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model
- Parameters:
model_id (str) – 训练模型的唯一标识符。
docs (Sequence[Mapping[str, Any]] | None) – 要传递给模型进行推理的对象数组。 这些对象应包含与配置的训练模型输入匹配的字段。 通常对于NLP模型，字段名是 text_field。 目前对于NLP模型，只允许单个值。
inference_config (Mapping[str, Any] | None) – 在API调用上应用的推理配置更新
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 控制等待推理结果的时间量。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- info(*, error_trace=None, filter_path=None, human=None, pretty=None)
获取机器学习信息。 获取机器学习使用的默认值和限制。 此端点设计用于用户界面，需要完全理解未指定某些选项的机器学习配置， 这意味着应使用默认值。此端点可用于查找这些默认值是什么。 它还提供有关在当前集群配置中可以运行的机器学习作业最大大小的信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info
- open_job(*, job_id, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None, body=None)
开启异常检测任务。
异常检测任务必须开启后才能接收和分析数据。在其生命周期内可以多次开启和关闭。 当开启一个新任务时，它会从一个空模型开始。 当开启一个现有任务时，会自动加载最新的模型状态。一旦接收到新数据， 任务就能从上次停止的地方继续进行分析。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job
- post_calendar_events(*, calendar_id, events=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)
向日历添加计划事件。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events
- Parameters:
- Return type:
- post_data(*, job_id, data=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None, reset_end=None, reset_start=None)
向异常检测任务发送数据进行分析。
重要提示：对于每个任务，一次只能接受来自单个连接的数据。 目前不支持使用通配符或逗号分隔的列表向多个任务发送数据。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data
- preview_data_frame_analytics(*, id=None, config=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)
预览数据框分析使用的特征。 预览数据框分析配置所使用的提取特征。
- Parameters:
- Return type:
- preview_datafeed(*, datafeed_id=None, datafeed_config=None, end=None, error_trace=None, filter_path=None, human=None, job_config=None, pretty=None, start=None, body=None)
预览数据馈送。 此API返回数据馈送的第一"页"搜索结果。 您可以预览现有数据馈送，或在API中提供数据馈送和异常检测任务的配置详情。 预览显示将传递给异常检测引擎的数据结构。 重要提示：当启用Elasticsearch安全功能时，预览使用调用API的用户凭证。 但是当数据馈送启动时，它会使用最后创建或更新数据馈送的用户的角色。 要获得准确反映数据馈送行为的预览，请使用适当的凭证。 您也可以使用辅助授权头来提供凭证。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed
- Parameters:
datafeed_id (str | None) – 唯一标识数据馈送的数字字符串。此标识符可包含小写字母数字字符(a-z和0-9)、 连字符和下划线。必须以字母数字字符开头和结尾。注意：如果使用此路径参数， 则不能在请求体中提供数据馈送或异常检测任务配置详情。
job_config (Mapping[str, Any] | None) – 与数据馈送关联的异常检测任务的配置详情。如果`datafeed_config`对象 不包含引用现有异常检测任务的`job_id`，则必须提供此`job_config`对象。 如果同时包含`job_id`和`job_config`，则使用后者信息。除非同时提供`datafeed_config`对象， 否则不能指定`job_config`对象。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_calendar(*, calendar_id, description=None, error_trace=None, filter_path=None, human=None, job_ids=None, pretty=None, body=None)
创建日历。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar
- put_calendar_job(*, calendar_id, job_id, error_trace=None, filter_path=None, human=None, pretty=None)
将异常检测作业添加到日历。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job
- put_data_frame_analytics(*, id, analysis=None, dest=None, source=None, allow_lazy_start=None, analyzed_fields=None, description=None, error_trace=None, filter_path=None, headers=None, human=None, max_num_threads=None, meta=None, model_memory_limit=None, pretty=None, version=None, body=None)
创建数据框分析作业。 此API创建一个数据框分析作业，对源索引执行分析并将结果存储在目标索引中。 默认情况下，源配置中使用的查询是
{"match_all": {}}。如果目标索引不存在，将在启动作业时自动创建。
如果仅提供回归或分类参数的子集，将进行超参数优化。它会为每个未定义的参数确定一个值。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics
- Parameters:
id (str) – 数据框分析作业的标识符。可包含小写字母数字字符(a-z和0-9)、连字符和下划线。必须以字母数字字符开头和结尾。
analysis (Mapping[str, Any] | None) – 分析配置，包含执行以下类型分析所需的信息：分类、异常检测或回归。
allow_lazy_start (bool | None) – 指定当机器学习节点容量不足时，此作业是否可以启动。如果设置为`false`且无法立即找到有容量运行作业的机器学习节点，API将返回错误。如果设置为`true`，API不会返回错误；作业将保持在`starting`状态，直到有足够的机器学习节点容量可用。此行为还受集群范围的`xpack.ml.max_lazy_ml_nodes`设置影响。
analyzed_fields (Mapping[str, Any] | None) – 指定`includes`和/或`excludes`模式来选择哪些字段将包含在分析中。excludes`中指定的模式最后应用，因此`excludes`具有优先权。换句话说，如果同一字段在`includes`和`excludes`中都指定，则该字段不会包含在分析中。如果未设置`analyzed_fields，则仅包含相关字段。例如，异常检测的所有数值字段。支持的字段因每种分析类型而异。异常检测需要分析数值或`boolean`数据。算法不支持缺失值，因此忽略非数值或布尔类型的字段。包含字段含有缺失值、空值或数组的文档也会被忽略。因此`dest`索引可能包含没有异常分数的文档。回归支持数值、boolean、text、keyword`和`ip`数据类型的字段。它也容忍缺失值。支持的字段包含在分析中，其他字段被忽略。包含字段含有两个或更多值的数组的文档也会被忽略。`dest`索引中不包含结果字段的文档不包括在回归分析中。分类支持数值、`boolean、text、keyword`和`ip`数据类型的字段。它也容忍缺失值。支持的字段包含在分析中，其他字段被忽略。包含字段含有两个或更多值的数组的文档也会被忽略。`dest`索引中不包含结果字段的文档不包括在分类分析中。通过将序数变量值映射到单个数字可以改进分类分析。例如，对于年龄范围，可以将值建模为`0-14 = 0、15-24 = 1、`25-34 = 2`等。
description (str | None) – 作业的描述。
max_num_threads (int | None) – 分析使用的最大线程数。使用更多线程可能会减少完成分析所需的时间，但会消耗更多CPU。注意，该过程可能会使用额外的线程用于分析本身以外的操作功能。
model_memory_limit (str | None) – 允许用于分析处理的大致最大内存资源量。如果`elasticsearch.yml`文件包含`xpack.ml.max_model_memory_limit`设置，当尝试创建`model_memory_limit`值大于该设置的数据框分析作业时，将发生错误。
version (str | None)
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_datafeed(*, datafeed_id, aggregations=None, aggs=None, allow_no_indices=None, chunking_config=None, delayed_data_check_config=None, error_trace=None, expand_wildcards=None, filter_path=None, frequency=None, headers=None, human=None, ignore_throttled=None, ignore_unavailable=None, indexes=None, indices=None, indices_options=None, job_id=None, max_empty_searches=None, pretty=None, query=None, query_delay=None, runtime_mappings=None, script_fields=None, scroll_size=None, body=None)
创建数据馈送。 数据馈送从Elasticsearch检索数据供异常检测作业分析。 每个异常检测作业只能关联一个数据馈送。 数据馈送包含以定义间隔(
frequency)运行的查询。 如果担心数据延迟，可以在每个间隔添加延迟(query_delay')。默认情况下，数据馈送使用以下查询：{"match_all": {"boost": 1}}`。当启用Elasticsearch安全功能时，数据馈送会记住创建它的用户在创建时拥有的角色，并使用这些相同的角色运行查询。如果提供次要授权头，则使用这些凭据。 必须使用Kibana、此API或创建异常检测作业API来创建数据馈送。不要直接将数据馈送添加到
.ml-config索引。不要给用户在.ml-config索引上的write权限。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed
- Parameters:
datafeed_id (str) – 唯一标识数据馈送的数字字符串。可包含小写字母数字字符(a-z和0-9)、连字符和下划线。必须以字母数字字符开头和结尾。
aggregations (Mapping[str, Mapping[str, Any]] | None) – 如果设置，数据馈送执行聚合搜索。对聚合的支持有限，应仅用于低基数数据。
aggs (Mapping[str, Mapping[str, Any]] | None) – 如果设置，数据馈送执行聚合搜索。对聚合的支持有限，应仅用于低基数数据。
allow_no_indices (bool | None) – 如果为true，则忽略解析为无具体索引的通配符索引表达式。包括`_all`字符串或未指定索引时。
chunking_config (Mapping[str, Any] | None) – 数据馈送可能需要搜索长时间段，如几个月或几年。此搜索被分成时间块以确保管理Elasticsearch的负载。分块配置控制如何计算这些时间块的大小；这是一个高级配置选项。
delayed_data_check_config (Mapping[str, Any] | None) – 指定数据馈送是否检查缺失数据及窗口大小。数据馈送可以选择性地搜索已读取的索引，以确定是否有任何数据随后被添加到索引中。如果发现缺失数据，这很好地表明`query_delay`设置得太低，数据在数据馈送经过该时间点后被索引。此检查仅在实时数据馈送上运行。
expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – 通配符模式可以匹配的索引类型。如果请求可以针对数据流，此参数确定通配符表达式是否匹配隐藏的数据流。支持逗号分隔的值。
frequency (str | Literal[-1] | ~typing.Literal[0] | None) – 数据馈送在实时运行时进行计划查询的间隔。默认值是短桶跨度的桶跨度，或对于较长桶跨度，桶跨度的合理分数。当`frequency`短于桶跨度时，最后一个(部分)桶的临时结果被写入，然后最终被完整桶结果覆盖。如果数据馈送使用聚合，此值必须能被日期直方图聚合的间隔整除。
ignore_throttled (bool | None) – 如果为true，冻结时忽略具体、扩展或别名索引。
ignore_unavailable (bool | None) – 如果为true，忽略不可用索引(缺失或关闭)。
indexes (str | Sequence[str] | None) – 索引名称数组。支持通配符。如果任何索引在远程集群中，主节点和机器学习节点必须具有`remote_cluster_client`角色。
indices (str | Sequence[str] | None) – 索引名称数组。支持通配符。如果任何索引在远程集群中，主节点和机器学习节点必须具有`remote_cluster_client`角色。
indices_options (Mapping[str, Any] | None) – 指定搜索期间使用的索引扩展选项
job_id (str | None) – 异常检测作业的标识符。
max_empty_searches (int | None) – 如果实时数据馈送从未看到任何数据(包括任何初始训练期间)，在这么多实时搜索返回无文档后，它会自动停止并关闭关联的作业。换句话说，它在`frequency`乘以`max_empty_searches`的实时操作后停止。如果未设置，无结束时间且看不到数据的数据馈送将保持启动状态，直到显式停止。默认情况下，不设置。
query (Mapping[str, Any] | None) – Elasticsearch查询领域特定语言(DSL)。此值对应于Elasticsearch搜索POST正文中的查询对象。支持Elasticsearch的所有选项，因为此对象原样传递给Elasticsearch。
query_delay (str | Literal[-1] | ~typing.Literal[0] | None) – 查询数据相对于实时时间的延迟秒数。例如，如果10:04 a.m.的数据可能在10:06 a.m.之前无法在Elasticsearch中搜索，将此属性设置为120秒。默认值在`60s`和`120s`之间随机选择。当同一节点上运行多个作业时，此随机性提高了查询性能。
runtime_mappings (Mapping[str, Mapping[str, Any]] | None) – 指定数据馈送搜索的运行时字段。
script_fields (Mapping[str, Mapping[str, Any]] | None) – 指定评估自定义表达式并返回脚本字段给数据馈送的脚本。作业中的检测器配置对象可以包含使用这些脚本字段的函数。
scroll_size (int | None) – 当数据馈送不使用聚合时，在Elasticsearch搜索中使用的size参数。最大值是`index.max_result_window`的值，默认为10,000。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_filter(*, filter_id, description=None, error_trace=None, filter_path=None, human=None, items=None, pretty=None, body=None)
创建过滤器。 过滤器包含字符串列表。可以被一个或多个异常检测作业使用。 具体来说，过滤器在检测器配置对象的
custom_rules属性中被引用。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter
- Parameters:
- Return type:
- put_job(*, job_id, analysis_config=None, data_description=None, allow_lazy_open=None, allow_no_indices=None, analysis_limits=None, background_persist_interval=None, custom_settings=None, daily_model_snapshot_retention_after_days=None, datafeed_config=None, description=None, error_trace=None, expand_wildcards=None, filter_path=None, groups=None, human=None, ignore_throttled=None, ignore_unavailable=None, model_plot_config=None, model_snapshot_retention_days=None, pretty=None, renormalization_window_days=None, results_index_name=None, results_retention_days=None, body=None)
创建异常检测任务。
如果包含
datafeed_config，则必须对源索引具有读取权限。 如果包含datafeed_config但未提供查询，数据馈送将使用{"match_all": {"boost": 1}}。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job
- Parameters:
job_id (str) – 异常检测任务的唯一标识符。该标识符 可包含小写字母数字字符（a-z和0-9）、连字符和 下划线。必须以字母数字字符开头和结尾。
analysis_config (Mapping[str, Any] | None) – 指定如何分析数据。创建任务后， 分析配置不可更改；所有属性均为 信息性内容。
data_description (Mapping[str, Any] | None) – 定义通过post data API向任务发送数据时 输入数据的格式。注意配置数据馈送时， 这些属性会自动设置。通过post data API接收的数据 不会存储在Elasticsearch中，仅保留异常 检测结果。
allow_lazy_open (bool | None) – 高级配置选项。指定当机器学习节点容量不足 无法立即分配节点时是否允许此任务打开。 默认情况下，如果找不到有容量运行任务的机器学习节点， open anomaly detection jobs API会返回错误。但这还受 集群级`xpack.ml.max_lazy_ml_nodes`设置影响。若设为true， 该API不会返回错误，任务会保持打开状态等待 足够的机器学习节点容量。
allow_no_indices (bool | None) – 若为`true`，则忽略解析为无具体索引的 通配符索引表达式。包括`_all`字符串或 未指定索引的情况。
analysis_limits (Mapping[str, Any] | None) – 可设置内存中数学模型所需资源的 限制。这些限制是近似值，可按任务设置。 它们不控制其他进程（如Elasticsearch Java进程） 的内存使用。
background_persist_interval (str | Literal[-1] | ~typing.Literal[0] | None) – 高级配置选项。模型 周期性持久化的间隔时间。默认值为3至4小时之间的 随机值，避免所有任务同时持久化。最小允许值为1小时。 对于非常大的模型（几GB），持久化可能需要10-20分钟， 因此不要将`background_persist_interval`设得过低。
custom_settings (Any | None) – 高级配置选项。包含任务的 自定义元数据。
daily_model_snapshot_retention_after_days (int | None) – 高级配置选项， 影响此任务旧模型快照的自动删除。指定一段时间（天数）， 之后仅保留每天的第一个快照。该时间段相对于 此任务最新快照的时间戳。有效值范围为0到`model_snapshot_retention_days`。
datafeed_config (Mapping[str, Any] | None) – 为异常检测任务定义数据馈送。如果 启用了Elasticsearch安全功能，数据馈送会记住创建时用户的 角色，并使用相同角色运行查询。如果提供次要授权头， 则使用这些凭据替代。
description (str | None) – 任务的描述信息。
expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – 通配符可匹配的索引类型。如果请求 可以针对数据流，此参数决定通配符表达式是否匹配 隐藏数据流。支持逗号分隔值。
ignore_throttled (bool | None) – 若为`true`，冻结时忽略具体、扩展或别名索引。
ignore_unavailable (bool | None) – 若为`true`，忽略不可用索引（缺失或关闭）。
model_plot_config (Mapping[str, Any] | None) – 此高级配置选项将模型信息 与结果一起存储。它提供更详细的异常检测视图。 启用模型绘图会显著增加系统性能开销； 对于具有许多实体的任务不可行。模型绘图 提供模型及其边界的简化指示视图。 它不显示复杂特征如多变量相关性或多模态 数据。因此，偶尔可能报告模型绘图中 不可见的异常。模型绘图配置可在创建任务时 或之后更新。如遇性能问题必须禁用。
model_snapshot_retention_days (int | None) – 高级配置选项，影响 此任务旧模型快照的自动删除。指定快照保留的 最长时间段（天数）。该时间段相对于 此任务最新快照的时间戳。默认删除比最新快照 早十天的快照。
renormalization_window_days (int | None) – 高级配置选项。随着 新数据出现，分数调整应用的时间段。 默认值为30天或100个桶跨度中的较大者。
results_index_name (str | None) – 影响机器学习结果索引名称的 文本字符串。默认生成名为`.ml-anomalies-shared`的索引。
results_retention_days (int | None) – 高级配置选项。结果保留的 时间段（天数）。年龄相对于最新桶结果的时间戳 计算。若非null值，每天00:30（服务器时间）会删除 比最新桶结果早指定天数的结果。默认值为null， 表示保留所有结果。系统生成的注释也计入保留范围； 它们与结果在相同天数后删除。用户添加的注释永久保留。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_trained_model(*, model_id, compressed_definition=None, defer_definition_decompression=None, definition=None, description=None, error_trace=None, filter_path=None, human=None, inference_config=None, input=None, metadata=None, model_size_bytes=None, model_type=None, platform_architecture=None, prefix_strings=None, pretty=None, tags=None, wait_for_completion=None, body=None)
创建训练好的模型。 允许提供非由数据框分析创建的训练模型。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model
- Parameters:
model_id (str) – 训练模型的唯一标识符。
compressed_definition (str | None) – 模型的压缩（GZip和Base64编码）推理 定义。若指定compressed_definition，则不能指定definition。
defer_definition_decompression (bool | None) – 若设为`true`且提供`compressed_definition`， 请求会延迟定义解压并跳过相关验证。
definition (Mapping[str, Any] | None) – 模型的推理定义。若指定definition， 则不能指定compressed_definition。
description (str | None) – 推理训练模型的人类可读描述。
inference_config (Mapping[str, Any] | None) – 推理的默认配置。可以是 回归或分类配置。必须与底层definition.trained_model的 target_type匹配。对于预打包模型如ELSER， 不需要配置。
metadata (Any | None) – 包含模型元数据的对象映射。
model_size_bytes (int | None) – 内存中保留训练模型的 估计内存使用量（字节）。仅当defer_definition_decompression 为true或未提供模型定义时支持此属性。
model_type (str | Literal['lang_ident', 'pytorch', 'tree_ensemble'] | None) – 模型类型。
platform_architecture (str | None) – 训练模型的平台架构 （如适用）。如果模型仅适用于一个平台（因为针对特定 处理器架构和操作系统组合进行了深度优化），则此字段 指定平台。字符串格式必须匹配Elasticsearch使用的平台 标识符，如`linux-x86_64`、linux-aarch64、 darwin-x86_64、darwin-aarch64`或`windows-x86_64。 对于便携式模型（独立于处理器架构或OS功能工作的模型）， 不设置此字段。
wait_for_completion (bool | None) – 是否等待所有子操作（如模型下载）完成。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_trained_model_alias(*, model_id, model_alias, error_trace=None, filter_path=None, human=None, pretty=None, reassign=None)
创建或更新训练模型别名。 训练模型别名是用于引用单个训练模型的逻辑名称。 可以使用别名替代训练模型标识符，使模型引用更简便。 例如，在推理聚合和处理器中使用别名。 别名必须唯一且仅引用单个训练模型。但每个训练模型 可以有多个别名。 如果使用此API更新别名使其引用不同的训练模型ID， 且模型使用不同类型的数据框分析，会发生错误。 例如，当有用于回归分析和分类分析的训练模型时， 不能将别名从一种训练模型重新分配给另一种。 如果使用此API更新别名且新旧训练模型之间共同 输入字段很少，API会返回警告。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias
- Parameters:
- Return type:
- put_trained_model_definition_part(*, model_id, part, definition=None, total_definition_length=None, total_parts=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)
创建训练模型定义的一部分。
- Parameters:
model_id (str) – 训练模型的唯一标识符。
part (int) – 定义部分编号。加载定义进行推理时， 按部分编号顺序流式传输定义部分。 第一部分必须为`0`，最后部分必须为`total_parts - 1`。
definition (str | None) – 模型的定义部分。必须是Base64编码字符串。
total_definition_length (int | None) – 总未压缩定义长度（字节）。 非Base64编码。
total_parts (int | None) – 将上传的总部分数。必须大于0。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_trained_model_vocabulary(*, model_id, vocabulary=None, error_trace=None, filter_path=None, human=None, merges=None, pretty=None, scores=None, body=None)
创建训练模型词汇表。 此API仅支持自然语言处理(NLP)模型。 词汇表按照训练模型定义中
inference_config.*.vocabulary的描述存储在索引中。
- reset_job(*, job_id, delete_user_annotations=None, error_trace=None, filter_path=None, human=None, pretty=None, wait_for_completion=None)
重置异常检测任务。 所有模型状态和结果都将被删除。任务将恢复到刚创建时的初始状态， 可以重新开始运行。 目前不支持使用通配符或逗号分隔列表来批量重置多个任务。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job
- Parameters:
- Return type:
- revert_model_snapshot(*, job_id, snapshot_id, delete_intervening_results=None, error_trace=None, filter_path=None, human=None, pretty=None, body=None)
回滚到快照。 机器学习功能会快速响应异常输入，学习数据中的新行为。 高度异常的输入会增加模型的方差，同时系统会判断这是行为的新变化 还是偶发事件。如果已知该异常输入是偶发事件，则可以将模型状态重置 到该事件发生之前的时间点。例如，在黑色星期五或关键系统故障后， 您可以考虑回滚到保存的快照。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot
- set_upgrade_mode(*, enabled=None, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None)
设置ML索引的升级模式。 设置集群范围的upgrade_mode参数，为机器学习索引的升级做准备。 在升级集群时，某些情况下需要重启节点并重建机器学习索引。 在这些情况下，必须没有正在运行的机器学习任务。您可以关闭机器学习任务， 完成升级后再重新打开所有任务。或者，您可以使用此API临时停止与任务和 数据馈送相关的操作，并阻止新任务启动。对于不需要重建机器学习索引的升级， 也可以使用此API，尽管在这种情况下停止任务不是必须的。 您可以通过获取机器学习信息API查看当前upgrade_mode设置的值。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode
- Parameters:
- Return type:
- start_data_frame_analytics(*, id, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None)
启动数据框分析任务。 数据框分析任务在其生命周期内可以多次启动和停止。 如果目标索引不存在，将在首次启动数据框分析任务时自动创建。 目标索引的
index.number_of_shards和index.number_of_replicas设置会从源索引复制。如果有多个源索引，则目标索引会复制最高的设置值。 目标索引的映射也会从源索引复制。如果存在任何映射冲突，任务将无法启动。 如果目标索引已存在，则直接使用现有索引。因此您可以预先设置目标索引的 自定义设置和映射。https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics
- Parameters:
- Return type:
- start_datafeed(*, datafeed_id, end=None, error_trace=None, filter_path=None, human=None, pretty=None, start=None, timeout=None, body=None)
启动数据馈送。
必须启动数据馈送才能从Elasticsearch检索数据。数据馈送在其生命周期内可以多次启动和停止。
在启动数据馈送前，异常检测任务必须处于开启状态，否则会发生错误。
如果重启已停止的数据馈送，它会从停止时的下一个毫秒继续处理输入数据。 如果在停止和启动之间的那个精确毫秒内索引了新数据，这些数据将被忽略。
当启用Elasticsearch安全功能时，您的数据馈送会记住最后一次创建或更新它的用户 在创建或更新时拥有的角色，并使用这些相同的角色运行查询。如果在创建或更新数据馈送时 提供了二级授权头，则将使用这些凭据。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed
- start_trained_model_deployment(*, model_id, adaptive_allocations=None, cache_size=None, deployment_id=None, error_trace=None, filter_path=None, human=None, number_of_allocations=None, pretty=None, priority=None, queue_capacity=None, threads_per_allocation=None, timeout=None, wait_for=None, body=None)
启动已训练模型的部署。 该操作会将模型分配到每个机器学习节点上。
- Parameters:
model_id (str) – 训练模型的唯一标识符。当前仅支持 PyTorch 模型。
adaptive_allocations (Mapping[str, Any] | None) – 自适应分配配置。启用时，分配数量会根据当前负载自动设置。 如果启用了 adaptive_allocations，请不要手动设置分配数量。
cache_size (int | str | None) – 每个节点上模型推理缓存的大小（JVM堆外内存）。默认值与 model_size_bytes 相同。 要禁用缓存，可设置为 0b。
deployment_id (str | None) – 模型部署的唯一标识符。
number_of_allocations (int | None) – 部署模型的每个节点上的模型分配数量。节点上的所有分配共享内存中的同一模型副本， 但使用独立的线程集来评估模型。增加此值通常会提高吞吐量。如果该设置值大于硬件线程数， 将自动调整为小于硬件线程数的值。如果启用了 adaptive_allocations，请不要设置此值， 因为它会自动设置。
queue_capacity (int | None) – 指定队列中允许的推理请求数量。超过此值后，新请求将被拒绝并返回429错误。
threads_per_allocation (int | None) – 设置每个模型分配在推理期间使用的线程数。这通常会提高推理速度。 推理过程是计算密集型过程；任何大于机器可用硬件线程数的值都不会提高推理速度。 如果该设置值大于硬件线程数，将自动调整为小于硬件线程数的值。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 指定等待模型部署完成的时间。
wait_for (str | Literal['fully_allocated', 'started', 'starting'] | None) – 指定在返回前等待的分配状态。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- stop_data_frame_analytics(*, id, allow_no_match=None, error_trace=None, filter_path=None, force=None, human=None, pretty=None, timeout=None)
停止数据帧分析作业。 数据帧分析作业在其生命周期内可以多次启动和停止。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics
- Parameters:
id (str) – 数据帧分析作业的标识符。可包含小写字母数字字符（a-z和0-9）、连字符和下划线， 必须以字母数字字符开头和结尾。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：1.包含通配符表达式但没有匹配的数据帧分析作业； 2.包含 _all 字符串或无标识符且没有匹配项；3.包含通配符表达式但只有部分匹配。 默认值为 true，表示无匹配时返回空 data_frame_analytics 数组，部分匹配时返回结果子集。 如果此参数为 false，当无匹配或只有部分匹配时请求将返回404状态码。
force (bool | None) – 如果为 true，则强制停止数据帧分析作业。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 控制等待数据帧分析作业停止的时间，默认为20秒。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- stop_datafeed(*, datafeed_id, allow_no_match=None, error_trace=None, filter_path=None, force=None, human=None, pretty=None, timeout=None, body=None)
停止数据馈送。 停止的数据馈送将不再从Elasticsearch检索数据。数据馈送在其生命周期内可以多次启动和停止。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed
- Parameters:
datafeed_id (str) – 数据馈送的标识符。可以通过逗号分隔的列表或通配符表达式在单个API请求中停止多个数据馈送。 使用 _all 或指定 * 作为标识符可以关闭所有数据馈送。
allow_no_match (bool | None) – 参考 allow_no_match 查询参数的描述。
force (bool | None) – 参考 force 查询参数的描述。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 参考 timeout 查询参数的描述。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- stop_trained_model_deployment(*, model_id, allow_no_match=None, error_trace=None, filter_path=None, force=None, human=None, pretty=None)
停止已训练模型的部署。
- Parameters:
model_id (str) – 训练模型的唯一标识符。
allow_no_match (bool | None) – 指定当请求出现以下情况时的处理方式：包含通配符表达式但没有匹配的部署； 包含 _all 字符串或无标识符且没有匹配项；或包含通配符表达式但只有部分匹配。 默认情况下，无匹配时返回空数组，部分匹配时返回结果子集。如果为 false， 当无匹配或只有部分匹配时请求将返回404状态码。
force (bool | None) – 强制停止部署，即使它被摄入管道使用。在重新启动模型部署前无法使用这些管道。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- update_data_frame_analytics(*, id, allow_lazy_start=None, description=None, error_trace=None, filter_path=None, human=None, max_num_threads=None, model_memory_limit=None, pretty=None, body=None)
更新数据帧分析作业。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics
- Parameters:
id (str) – 数据帧分析作业的标识符。可包含小写字母数字字符（a-z和0-9）、连字符和下划线， 必须以字母数字字符开头和结尾。
allow_lazy_start (bool | None) – 指定当机器学习节点容量不足无法立即分配节点时，是否允许此作业延迟启动。
description (str | None) – 作业的描述信息。
max_num_threads (int | None) – 分析使用的最大线程数。使用更多线程可能会减少完成分析所需的时间， 但会消耗更多CPU资源。注意：除分析本身外，该过程可能会使用额外线程进行其他操作功能。
model_memory_limit (str | None) – 允许用于分析处理的最大内存资源近似值。如果 elasticsearch.yml 文件 包含 xpack.ml.max_model_memory_limit 设置，当尝试创建 model_memory_limit 值 大于该设置的数据帧分析作业时会发生错误。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- update_datafeed(*, datafeed_id, aggregations=None, allow_no_indices=None, chunking_config=None, delayed_data_check_config=None, error_trace=None, expand_wildcards=None, filter_path=None, frequency=None, human=None, ignore_throttled=None, ignore_unavailable=None, indexes=None, indices=None, indices_options=None, job_id=None, max_empty_searches=None, pretty=None, query=None, query_delay=None, runtime_mappings=None, script_fields=None, scroll_size=None, body=None)
更新数据馈送。 必须停止并重新启动数据馈送才能使更改生效。 当启用 Elasticsearch 安全功能时，数据馈送会记住更新它的用户在更新时所拥有的角色，并使用这些相同的角色运行查询。如果提供了次要授权头，则使用这些凭据代替。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed
- Parameters:
datafeed_id (str) – 唯一标识数据馈送的数字字符串。 此标识符可以包含小写字母数字字符（a-z 和 0-9）、连字符和下划线。必须以字母数字 字符开头和结尾。
aggregations (Mapping[str, Mapping[str, Any]] | None) – 如果设置，数据馈送将执行聚合搜索。对 聚合的支持有限，应仅用于低基数 数据。
allow_no_indices (bool | None) – 如果为 true，则忽略解析为 无具体索引的通配符索引表达式。这包括 _all 字符串或 未指定索引时的情况。
chunking_config (Mapping[str, Any] | None) – 数据馈送可能会搜索很长的时间段，例如几个月或几年。 此搜索被分成时间块，以确保 管理 Elasticsearch 上的负载。分块配置控制如何 计算这些时间块的大小；这是一个高级配置 选项。
delayed_data_check_config (Mapping[str, Any] | None) – 指定数据馈送是否检查缺失 数据以及窗口的大小。数据馈送可以选择搜索 已经读取的索引，以确定是否有任何 数据随后被添加到索引中。如果发现缺失数据， 这很好地表明 query_delay 设置得太低，数据 在数据馈送经过该时间点后被索引。此 检查仅在实时数据馈送上运行。
expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – 通配符模式可以匹配的索引类型。如果 请求可以针对数据流，此参数确定通配符 表达式是否匹配隐藏的数据流。支持逗号分隔的值。
frequency (str | Literal[-1] | ~typing.Literal[0] | None) – 数据馈送在实时运行时进行计划查询的间隔。 默认值是短桶跨度的桶跨度，或对于较长的桶跨度， 桶跨度的合理部分。当 frequency 短于桶跨度时， 最后一个（部分）桶的临时结果会被写入，然后最终被 完整桶结果覆盖。如果数据馈送使用聚合，此值必须 能被日期直方图聚合的间隔整除。
ignore_throttled (bool | None) – 如果为 true，冻结时忽略具体、扩展或别名的索引。
ignore_unavailable (bool | None) – 如果为 true，忽略不可用的索引（缺失或关闭）。
indexes (Sequence[str] | None) – 索引名称数组。支持通配符。如果任何 索引位于远程集群中，机器学习节点必须具有 remote_cluster_client 角色。
indices (Sequence[str] | None) – 索引名称数组。支持通配符。如果任何 索引位于远程集群中，机器学习节点必须具有 remote_cluster_client 角色。
indices_options (Mapping[str, Any] | None) – 指定搜索期间使用的索引扩展选项。
job_id (str | None)
max_empty_searches (int | None) – 如果实时数据馈送从未看到任何数据（包括 任何初始训练期间），在此多次实时搜索返回无文档后， 它会自动停止并关闭关联的作业。换句话说， 它在 frequency 乘以 max_empty_searches 次实时操作后停止。 如果未设置，没有结束时间且未看到数据的数据馈送将保持 启动状态，直到显式停止。默认情况下，不设置。
query (Mapping[str, Any] | None) – Elasticsearch 查询领域特定语言（DSL）。此值 对应于 Elasticsearch 搜索 POST 主体中的查询对象。 Elasticsearch 支持的所有选项都可以使用，因为此对象 原样传递给 Elasticsearch。请注意，如果更改查询， 分析的数据也会更改。因此，学习所需的时间可能 很长，结果的可理解性不可预测。如果要 对源数据进行重大更改，建议克隆 作业和数据馈送，并在克隆中进行修改。让 两者并行运行，并在对作业结果满意时关闭其中一个。
query_delay (str | Literal[-1] | ~typing.Literal[0] | None) – 查询数据时相对于实时时间的延迟秒数。 例如，如果上午 10:04 的数据可能在 Elasticsearch 中 直到上午 10:06 才可搜索，请将此属性设置为 120 秒。默认值 在 60s 和 120s 之间随机选择。这种随机性提高了 当同一节点上有多个作业运行时的查询性能。
runtime_mappings (Mapping[str, Mapping[str, Any]] | None) – 指定数据馈送搜索的运行时字段。
script_fields (Mapping[str, Mapping[str, Any]] | None) – 指定评估自定义表达式并 返回脚本字段给数据馈送的脚本。作业中的 检测器配置对象可以包含使用这些脚本字段的函数。
scroll_size (int | None) – 当数据馈送不使用聚合时，在 Elasticsearch 搜索中使用的 大小参数。最大值为 index.max_result_window 的值。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- update_filter(*, filter_id, add_items=None, description=None, error_trace=None, filter_path=None, human=None, pretty=None, remove_items=None, body=None)
更新过滤器。 更新过滤器的描述，添加项目或从列表中删除项目。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter
- update_job(*, job_id, allow_lazy_open=None, analysis_limits=None, background_persist_interval=None, categorization_filters=None, custom_settings=None, daily_model_snapshot_retention_after_days=None, description=None, detectors=None, error_trace=None, filter_path=None, groups=None, human=None, model_plot_config=None, model_prune_window=None, model_snapshot_retention_days=None, per_partition_categorization=None, pretty=None, renormalization_window_days=None, results_retention_days=None, body=None)
更新异常检测作业。 更新异常检测作业的某些属性。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job
- Parameters:
job_id (str) – 作业的标识符。
allow_lazy_open (bool | None) – 高级配置选项。指定此 作业是否可以在没有足够的机器学习节点容量时 打开，无法立即分配给节点。如果为 false 且 找不到具有运行作业容量的机器学习节点， 打开异常检测作业 API 返回错误。但是，这也受 集群范围的 xpack.ml.max_lazy_ml_nodes 设置影响。如果此选项 设置为 true，打开异常检测作业 API 不会返回错误， 作业将在打开状态等待，直到有足够的机器学习节点 容量可用。
background_persist_interval (str | Literal[-1] | ~typing.Literal[0] | None) – 高级配置选项。模型 每次周期性持久化之间的时间。默认值是 3 到 4 小时之间的 随机值，避免所有作业在同一时间持久化。 允许的最小值为 1 小时。对于非常大的模型（几 GB），持久化可能需要 10-20 分钟，因此不要将此值设置得太低。 如果在更新时作业处于打开状态，必须停止数据馈送， 关闭作业，然后重新打开作业并重新启动数据馈送以使更改 生效。
custom_settings (Mapping[str, Any] | None) – 高级配置选项。包含有关作业的 自定义元数据。例如，它可以包含自定义 URL 信息，如 向机器学习结果添加自定义 URL 中所示。
daily_model_snapshot_retention_after_days (int | None) – 高级配置选项， 影响此作业旧模型快照的自动删除。 它指定一段时间（以天为单位），之后仅保留 每天的第一个快照。此时间段相对于 此作业最新快照的时间戳。有效值范围为 0 到 model_snapshot_retention_days。 对于版本 7.8.0 之前创建的作业，默认值与 model_snapshot_retention_days 匹配。
description (str | None) – 作业的描述。
detectors (Sequence[Mapping[str, Any]] | None) – 检测器更新对象的数组。
model_prune_window (str | Literal[-1] | ~typing.Literal[0] | None)
model_snapshot_retention_days (int | None) – 高级配置选项，影响 此作业旧模型快照的自动删除。它指定 快照保留的最大时间段（以天为单位）。此时间段 相对于此作业最新快照的时间戳。
per_partition_categorization (Mapping[str, Any] | None) – 与分类如何与 分区字段交互相关的设置。
renormalization_window_days (int | None) – 高级配置选项。调整 分数应用的周期，随着新数据的出现。
results_retention_days (int | None) – 高级配置选项。结果保留的 时间段（以天为单位）。年龄是相对于最新桶结果的 时间戳计算的。如果此属性具有非空值， 每天在 00:30（服务器时间），比最新桶结果 早指定天数的结果将从 Elasticsearch 中删除。 默认值为 null，表示保留所有结果。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- update_model_snapshot(*, job_id, snapshot_id, description=None, error_trace=None, filter_path=None, human=None, pretty=None, retain=None, body=None)
更新快照。 更新快照的某些属性。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot
- update_trained_model_deployment(*, model_id, adaptive_allocations=None, error_trace=None, filter_path=None, human=None, number_of_allocations=None, pretty=None, body=None)
更新训练模型部署。
- Parameters:
model_id (str) – 训练模型的唯一标识符。目前仅 支持 PyTorch 模型。
adaptive_allocations (Mapping[str, Any] | None) – 自适应分配配置。启用时， 分配数量基于当前负载设置。如果启用了 adaptive_allocations， 不要手动设置分配数量。
number_of_allocations (int | None) – 部署模型的每个节点上的模型分配数量。 节点上的所有分配共享内存中的同一模型副本，但使用 单独的线程集来评估模型。增加此值通常会 提高吞吐量。如果此设置大于硬件线程数， 它将自动更改为小于硬件线程数的值。如果 启用了 adaptive_allocations，不要设置此值，因为它会自动设置。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- upgrade_job_snapshot(*, job_id, snapshot_id, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None, wait_for_completion=None)
升级快照。 将异常检测模型快照升级到最新主版本。 随着时间的推移，旧的快照格式会被弃用和移除。异常 检测作业仅支持当前或上一个主版本的快照。 此API提供将快照升级到当前主版本的方法。 这有助于为集群升级到下一个主版本做准备。 每次只能升级一个异常检测作业的快照，且 升级后的快照不能是该异常检测作业的当前快照。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot
- Parameters:
- Return type:
- validate(*, analysis_config=None, analysis_limits=None, data_description=None, description=None, error_trace=None, filter_path=None, human=None, job_id=None, model_plot=None, model_snapshot_id=None, model_snapshot_retention_days=None, pretty=None, results_index_name=None, body=None)
验证异常检测作业。
https://www.elastic.co/guide/en/machine-learning/master/ml-jobs.html
- validate_detector(*, detector=None, body=None, error_trace=None, filter_path=None, human=None, pretty=None)
验证异常检测作业。