跳到主要内容

事件

POST /events.add

描述

添加单个事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
allow_locked
可选
允许向已发布任务或模型添加事件
默认值false
布尔型
model_event
可选
如果设置,则事件用于模型。否则用于任务。不能与
任务日志事件一起使用。如果在批处理中使用,则所有事件应标记相同
默认值false
布尔型

响应

HTTP 代码模式
200对象

POST /events.add_batch

描述

在一次调用中添加一批事件(json-lines 格式,流友好)

参数

类型名称描述模式
请求体请求列表
必需
Json 编码的以换行符分隔的行,每行代表批处理中的一个事件,使用与 events.add 相同的参数< 对象 > 数组

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
已添加
可选
整型
错误
可选
整型
错误信息
可选
对象

POST /events.clear_scroll

描述

清除一个打开的滚动 ID

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
scroll_id
必需
由先前的事件服务调用返回的滚动 ID字符串

响应

HTTP 代码模式
200对象

POST /events.clear_task_log

描述

从任务中移除旧日志

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
allow_locked
可选
即使任务已锁定,也允许删除事件
默认值false
布尔型
exclude_metrics
可选
如果传入,则保留这些指标的事件< 字符串 > 数组
include_metrics
可选
如果传入,则仅删除这些指标的事件< 字符串 > 数组
任务
必需
任务 ID字符串
threshold_sec
可选
保留日志记录的时间阈值(秒)。较旧的日志记录将被
删除。如果未传入或为 0,则该任务的所有日志记录将被
删除
整型

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
删除
可选
已删除的日志记录数量整型

POST /events.debug_images

描述

获取每个任务在请求迭代次数下的调试图像事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
迭代次数
可选
返回调试图像的最大最新迭代次数整型
指标
必需
指标和变体列表< events.task_metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
navigate_earlier
可选
如果设置,则从最新迭代到最早迭代检索事件。
否则从最早迭代到最新迭代。默认值为 True
布尔型
refresh
可选
如果设置,则滚动将移至最新迭代。默认值为 False布尔型
scroll_id
可选
上一次调用的滚动 ID(用于获取更多结果)字符串

响应

HTTP 代码模式
200events.debug_images_response

POST /events.delete_for_model

描述

删除所有模型事件。此操作无法撤消!

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
allow_locked
可选
即使模型已锁定,也允许删除事件
默认值false
布尔型
模型
必需
模型 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
删除
可选
已删除事件数量布尔型

POST /events.delete_for_task

描述

删除所有任务事件。此操作无法撤消!

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
allow_locked
可选
即使任务已锁定,也允许删除事件
默认值false
布尔型
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
删除
可选
已删除事件数量布尔型

POST /events.download_task_log

描述

获取包含任务日志的附件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
line_format
可选
行字符串格式。在行类型为 'text' 时使用
默认值"{asctime} {worker} {level} {msg}"
字符串
line_type
可选
行格式类型枚举 (json, text)
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200字符串

POST /events.get_debug_image_sample

描述

返回给定迭代中每个指标和变体的调试图像

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
iteration
可选
获取调试图像的迭代次数。如果未指定,则获取最新
上报的图像
整型
metric
必需
指标名称字符串
model_events
可选
如果设置,则检索模型调试图像。否则检索任务调试图像
默认值false
布尔型
navigate_current_metric
可选
如果设置,则后续使用 next_debug_image_sample 的导航仅针对传入指标的调试图像进行。
否则针对所有指标
默认值true
布尔型
refresh
可选
如果设置,则滚动状态将刷新以反映调试图像中的最新更改
调试图像
布尔型
scroll_id
可选
上一次调用 get_debug_image_sample 返回的滚动 ID,或为空字符串
任务
必需
任务 ID字符串
variant
必需
指标变体字符串

响应

HTTP 代码模式
200events.debug_image_sample_response

POST /events.get_multi_task_metrics

描述

从指定类型的事件中获取唯一的指标和变体。仅
分析为传入任务或模型 ID 上报的事件。

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
event_type
可选
事件类型。如果未指定,则从所有类型
的上报事件中收集指标
events.event_type_enum
model_events
可选
如果未设置或设置为 False,则传入的 ID 是任务 ID,否则是模型 ID
默认值false
布尔型
任务
必需
要获取指标的任务 ID 列表< 字符串 > 数组

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
指标
可选
指标和变体列表< events.metric_variants > 数组

POST /events.get_multi_task_plots

描述

获取给定任务的 'plot' 事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
迭代次数
可选
返回绘图的最大最新迭代次数整型
last_iters_per_task_metric
可选
如果设置为 'true' 且传入 iters,则检索每个任务指标的最后迭代次数。
否则检索整个任务的最后迭代次数
默认值true
布尔型
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
no_scroll
可选
如果为 True,则不创建滚动。适用于一次性调用
默认值false
布尔型
scroll_id
可选
上一次调用的滚动 ID(用于获取更多结果)字符串
任务
必需
任务 ID 列表< 字符串 > 数组

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
绘图
可选
绘图映射(按任务名称键入)对象
已返回
可选
返回结果数量整型
scroll_id
可选
用于获取更多结果的滚动 ID字符串
总计
可选
此查询可用的总结果数量。如果结果数量超过
10000,则设置为 10000
数字

POST /events.get_plot_sample

描述

返回给定迭代的绘图

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
iteration
可选
获取绘图的迭代次数。如果未指定,则获取最新上报的
绘图
整型
metric
必需
指标名称字符串
model_events
可选
如果设置,则检索模型绘图。否则检索任务绘图
默认值false
布尔型
navigate_current_metric
可选
如果设置,则后续使用 next_plot_sample 的导航仅针对传入指标的绘图进行。
否则针对所有指标
默认值true
布尔型
refresh
可选
如果设置,则滚动状态将刷新以反映调试图像中的最新更改
绘图
布尔型
scroll_id
可选
上一次调用 get_plot_sample 返回的滚动 ID,或为空字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200events.plot_sample_response

POST /events.get_scalar_metric_data

描述

获取任务的标量指标数据

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
metric
可选
指标类型字符串
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
no_scroll
可选
如果为 True,则不创建滚动。适用于一次性调用
默认值false
布尔型
scroll_id
可选
上一次调用的滚动 ID(用于获取更多结果)字符串
任务
可选
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
事件
可选
任务标量指标事件< 对象 > 数组
已返回
可选
返回的事件数量整型
scroll_id
可选
用于获取更多结果的滚动 ID字符串
总计
可选
任务中的事件数量整型

POST /events.get_scalar_metrics_and_variants

描述

获取任务标量指标和变体

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
指标
可选
对象

POST /events.get_task_events

描述

滚动浏览任务事件,按时间戳排序

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
batch_size
可选
每次返回的事件数量(默认 500)整型
event_type
可选
仅返回此类型的事件字符串
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
order
可选
'asc'(默认)或 'desc'。枚举 (asc, desc)
scroll_id
可选
在下次调用时传递此值以获取下一页字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
事件
可选
事件列表< 对象 > 数组
已返回
可选
返回结果数量整型
scroll_id
可选
用于获取更多结果的滚动 ID字符串
总计
可选
此查询可用的总结果数量。如果结果数量超过
10000,则设置为 10000
数字

POST /events.get_task_latest_scalar_values

描述

获取任务的最新标量值

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
指标
可选
< metrics > 数组

指标

名称描述模式
名称
可选
指标名称字符串
变体
可选
< variants > 数组

变体

名称描述模式
last_100_value
可选
最后 100 个上报值的平均值数字
last_value
可选
最后上报的值数字
名称
可选
变体名称字符串

POST /events.get_task_log

描述

获取此任务的 'log' 事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
batch_size
可选
返回的日志事件数量整型
from_timestamp
可选
UTC 毫秒纪元时间,用作导航起点。可选。如果未提供,
参考时间戳由 'navigate_earlier' 参数确定(如果为 true,
参考时间戳是最后一个时间戳,如果为 false,参考时间戳是
第一个时间戳)
数字
navigate_earlier
可选
如果设置,则从最新到最早检索日志事件(按时间戳降序,除非 order='asc')。
否则从最早到最新(按时间戳升序,除非 order='desc')。
默认值为 True
默认是真
布尔型
order
可选
如果设置,则根据 'navigate_earlier' 的值改变返回日志事件的顺序
关于 'navigate_earlier'
枚举 (asc, desc)
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
事件
可选
日志条目列表< 对象 > 数组
已返回
可选
返回的日志事件数量整型
总计
可选
此查询可用的总日志事件数量。如果事件数量超过
10000,则设置为 10000
数字

POST /events.get_task_metrics

描述

对于每个任务,获取针对所请求事件类型已
上报的指标列表

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
event_type
可选
事件类型events.event_type_enum
model_events
可选
如果设置,则从模型事件中获取指标。否则从任务事件中获取
默认值false
布尔型
任务
必需
任务 ID< 字符串 > 数组

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
指标
可选
带有其指标的任务列表< 对象 > 数组

POST /events.get_task_plots

描述

获取此任务的所有 'plot' 事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
迭代次数
可选
返回绘图的最大最新迭代次数整型
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
no_scroll
可选
如果为 True,则不创建滚动。适用于一次性调用
默认值false
布尔型
scroll_id
可选
上一次调用的滚动 ID(用于获取更多结果)字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
绘图
可选
绘图列表< 对象 > 数组
已返回
可选
返回结果数量整型
scroll_id
可选
用于获取更多结果的滚动 ID字符串
总计
可选
此查询可用的总结果数量。如果结果数量超过
10000,则设置为 10000
数字

POST /events.get_task_single_value_metrics

描述

获取传入任务的单值指标

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
任务
必需
任务 ID 列表< 字符串 > 数组

响应

HTTP 代码模式
200events.single_value_metrics_response

POST /events.get_vector_metrics_and_variants

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
指标
可选
< 对象 > 数组

POST /events.multi_task_scalar_metrics_iter_histogram

描述

用于比较多个任务的标量统计直方图

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
key
可选
使用的直方图 x 轴:iter - 迭代次数 iso_time - 按 ISO 格式表示的事件时间
formatted string timestamp - 自纪元以来的毫秒时间戳
events.scalar_key_enum
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
样本数
可选
返回的直方图点数量。可选,默认值为 6000整型
任务
必需
任务 ID 列表。最大任务数量为 100< 字符串 > 数组

响应

HTTP 代码模式
200对象

POST /events.next_debug_image_sample

描述

获取同一迭代的下一个变体图像或下一迭代的图像
iteration

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
model_events
可选
如果设置,则检索模型调试图像。否则检索任务调试图像
默认值false
布尔型
navigate_earlier
可选
如果设置,则获取当前迭代的先前变体事件,或者(如果不存在)
前一次迭代的最后一个变体事件。
否则获取当前迭代的下一个变体事件或下一迭代的第一个变体事件
从下一个迭代
布尔型
next_iteration
可选
如果设置,则导航到下一个/上一个迭代
默认值false
布尔型
scroll_id
必需
上一次调用 get_debug_image_sample 返回的滚动 ID字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200events.debug_image_sample_response

POST /events.next_plot_sample

描述

获取同一迭代的下一个指标绘图或下一迭代的绘图
iteration

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
model_events
可选
如果设置,则检索模型绘图。否则检索任务绘图
默认值false
布尔型
navigate_earlier
可选
如果设置,则获取当前迭代的先前指标事件,或者(如果不存在)
前一次迭代的最后一个指标事件。
否则获取当前迭代的下一个指标事件或第一个指标事件
从下一个迭代
布尔型
next_iteration
可选
如果设置,则导航到下一个/上一个迭代
默认值false
布尔型
scroll_id
必需
上一次调用 get_plot_sample 返回的滚动 ID字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200events.plot_sample_response

POST /events.plots

描述

获取每个任务在请求迭代次数下的绘图事件

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
迭代次数
可选
返回绘图的最大最新迭代次数整型
指标
必需
指标和变体列表< events.task_metric_variants > 数组
model_events
可选
如果设置,则检索模型绘图。否则检索任务绘图
默认值false
布尔型
navigate_earlier
可选
如果设置,则从最新迭代到最早迭代检索事件。
否则从最早迭代到最新迭代。默认值为 True
布尔型
refresh
可选
如果设置,则滚动将移至最新迭代。默认值为 False布尔型
scroll_id
可选
上一次调用的滚动 ID(用于获取更多结果)字符串

响应

HTTP 代码模式
200events.plots_response

POST /events.scalar_metrics_iter_histogram

描述

获取任务中所有向量指标和变体的直方图数据

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
key
可选
使用的直方图 x 轴:iter - 迭代次数 iso_time - 按 ISO 格式表示的事件时间
formatted string timestamp - 自纪元以来的毫秒时间戳
events.scalar_key_enum
指标
可选
指标和变体列表< events.metric_variants > 数组
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
样本数
可选
返回的直方图点数量(0 表示返回所有点)。
可选,默认值为 6000。
整型
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
图像
可选
< 对象 > 数组

POST /events.scalar_metrics_iter_raw

描述

获取任务中特定指标变体的原始数据

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
batch_size
可选
此调用返回的数据点数量。可选,默认值为
10000。最大批量大小为 200000
整型
count_total
可选
计算总数据点数量。如果为 false,则不计算总数据点数量,
并返回 null
默认值false
布尔型
key
可选
要返回的 x 轴数组。支持的值:iter - 迭代次数 timestamp
- 自纪元以来的毫秒时间戳
events.scalar_key_enum
metric
必需
要返回数据点的指标和变体events.metric_variants
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
scroll_id
可选
可选的滚动 ID。用于在上次调用后获取更多数据点字符串
任务
必需
任务 ID字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称描述模式
已返回
可选
此调用返回的数据点数量。如果返回 0 个结果,则无
更多可用结果
整型
scroll_id
可选
滚动 ID。再次调用此端点时用于获取更多数据点字符串
总计
可选
总数据点数量。如果 count_total 为 false,则返回 null整型
变体
可选
每个变体的原始数据点对象

POST /events.vector_metrics_iter_histogram

描述

获取任务中所有标量指标和变体的直方图数据

参数

类型名称描述模式
请求体请求
必需
请求体请求

请求

名称描述模式
metric
必需
字符串
model_events
可选
如果设置,则检索模型事件。否则检索任务事件
默认值false
布尔型
任务
必需
任务 ID字符串
variant
必需
字符串

响应

HTTP 代码模式
200响应 200

响应 200

名称模式
图像
可选
< 对象 > 数组