reports
POST /reports.archive
描述
归档报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| comment 可选 | 客户端消息 | string |
| task 必填 | 要归档的报告任务 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| archived 可选 | 已归档的报告数量 (0 或 1) | integer |
POST /reports.create
描述
创建新报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| comment 可选 | 自由文本注释 | string |
| name 必填 | 报告名称。在公司内唯一。 | string |
| project 可选 | 分配此报告的项目 ID。必须存在[ab] | string |
| report 可选 | 报告模板 | string |
| report_assets 可选 | 外部报告资产列表 | < string > array |
| tags 可选 | 用户定义的标签列表 | < string > array |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| id 可选 | 报告 ID | string |
| project_id 可选 | 报告所属项目的 ID | string |
POST /reports.delete
描述
删除报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| force 可选 | 如果未设置，则已发布或未归档的报告无法删除 默认 : false | boolean |
| task 必填 | 要删除的报告任务 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| deleted 可选 | 已删除的报告数量 (0 或 1) | integer |
POST /reports.get_all_ex
描述
获取公司的所有报告任务和公共报告任务
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| all 可选 | 多字段模式条件（所有字段匹配模式） | reports.multi_field_pattern_data |
| any 可选 | 多字段模式条件（任意字段匹配模式） | reports.multi_field_pattern_data |
| allow_public 可选 | 允许在结果中返回公共报告 默认 : true | boolean |
| filters 可选 | < string, filters > map | |
| id 可选 | 要过滤的 ID 列表 | < string > array |
| include_subprojects 可选 | 如果设置为 'true' 且 project 字段已设置，则子项目中的报告也会被 搜索到 默认 : false | boolean |
| name 可选 | 只获取名称匹配此模式的报告（Python 正则表达式 语法） | string |
| only_fields 可选 | 报告字段名称列表（支持使用 '.' 嵌套）。如果提供，此 列表定义了查询的投影（每个结果条目只会返回这些字段） each result entry) | < string > array |
| order_by 可选 | 要排序的字段名称列表。当使用 search_text 时，可以使用 '@text_score' 作为字段，表示返回文档的文本得分。 使用 '-' 前缀指定降序。可选，建议在使用分页时使用。 prefix to specify descending order. Optional, recommended when using page | < string > array |
| page 可选 | 页码，返回报告结果列表中的特定页面 最小值 : 0 | integer |
| page_size 可选 | 每页大小，指定每页返回的结果数量（最后一页可能 包含较少结果） 最小值 : 1 | integer |
| project 可选 | 项目 ID 列表 | < string > array |
| refresh_scroll 可选 | 如果设置，则使用此滚动接收的所有数据将重新查询 | boolean |
| scroll_id 可选 | 从之前调用 get_all 返回的滚动 ID | string |
| search_text 可选 | 自由文本搜索查询 | string |
| size 可选 | 要检索的任务数量 最小值 : 1 | integer |
| status 可选 | 报告状态列表。 | < reports.report_status_enum > array |
| status_changed 可选 | 状态变更约束字符串列表（utcformat, epoch），带有可选 前缀修饰符 (>, >=, <, <=) | < string > array |
| system_tags 可选 | 报告系统标签列表。使用 '-' 前缀排除系统标签 | < string > array |
| tags 可选 | 报告用户定义的标签列表。使用 '-' 前缀排除标签 | < string > array |
| user 可选 | 用于按报告创建用户过滤结果的用户 ID 列表 | < string > array |
filters
| 名称 | 描述 | Schema |
|---|---|---|
| all 可选 | 'all' 条件中的所有术语都与 'and' 操作结合 | all |
| any 可选 | 'any' 条件中的所有术语都与 'or' 操作结合 | any |
| op 可选 | 如果同时提供了 'any' 和 'all'，则它们之间的操作 默认 : "and" | enum (and, or) |
all
| 名称 | Schema |
|---|---|
| exclude 可选 | < string > array |
| include 可选 | < string > array |
any
| 名称 | Schema |
|---|---|
| exclude 可选 | < string > array |
| include 可选 | < string > array |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| scroll_id 可选 | 可用于后续调用 get_all 以检索更多数据的滚动 ID | string |
| tasks 可选 | 报告任务列表 | < reports.report > array |
POST /reports.get_tags
描述
获取公司报告使用的所有用户标签
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | object |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| tags 可选 | 唯一标签值列表 | < string > array |
POST /reports.get_task_data
描述
根据传递的搜索条件 + 请求的事件获取任务数据
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| all 可选 | 多字段模式条件（所有字段匹配模式） | reports.multi_field_pattern_data |
| any 可选 | 多字段模式条件（任意字段匹配模式） | reports.multi_field_pattern_data |
| allow_public 可选 | 允许在结果中返回公共任务 默认 : true | boolean |
| debug_images 可选 | debug_images | |
| id 可选 | 要过滤的 ID 列表 | < string > array |
| include_subprojects 可选 | 如果设置为 'true' 且 project 字段已设置，则子项目中的任务也会被 搜索到 默认 : false | boolean |
| input.view.entries.dataset 可选 | 输入数据集 ID 列表 | < string > array |
| input.view.entries.version 可选 | 输入数据集版本 ID 列表 | < string > array |
| model_events 可选 | 如果设置，则检索模型事件。否则检索任务事件 默认 : false | boolean |
| name 可选 | 只获取名称匹配此模式的任务（Python 正则表达式 语法） | string |
| only_fields 可选 | 任务字段名称列表（支持使用 '.' 嵌套，例如 execution.model_labels)。如果提供，此列表定义了查询的投影 (每个结果条目只会返回这些字段) | < string > array |
| order_by 可选 | 要排序的字段名称列表。当使用 search_text 时，可以使用 '@text_score' 作为字段，表示返回文档的文本得分。 使用 '-' 前缀指定降序。可选，建议在使用分页时使用。 prefix to specify descending order. Optional, recommended when using page | < string > array |
| parent 可选 | 父 ID | string |
| plots 可选 | plots | |
| project 可选 | 项目 ID 列表 | < string > array |
| scalar_metrics_iter_histogram 可选 | scalar_metrics_iter_histogram | |
| search_hidden 可选 | 如果设置为 'true'，则隐藏任务包含在搜索结果中 默认 : false | boolean |
| search_text 可选 | 自由文本搜索查询 | string |
| single_value_metrics 可选 | 如果传递，则返回任务单值指标 | object |
| size 可选 | 要检索的任务数量 最小值 : 1 | integer |
| status 可选 | 任务状态列表。 | < reports.task_status_enum > array |
| status_changed 可选 | 状态变更约束字符串列表（utcformat, epoch），带有可选 前缀修饰符 (>, >=, <, <=) | < string > array |
| system_tags 可选 | 任务系统标签列表。使用 '-' 前缀排除系统标签 | < string > array |
| tags 可选 | 任务用户定义的标签列表。使用 '-' 前缀排除标签 | < string > array |
| type 可选 | 任务类型列表。以下一项或多项：'import', 'annotation', 'training' 或 'testing' (不区分大小写) | < string > array |
| user 可选 | 用于按任务创建用户过滤结果的用户 ID 列表 | < string > array |
debug_images
| 名称 | 描述 | Schema |
|---|---|---|
| iters 可选 | 返回调试图像的最新迭代的最大数量 | integer |
| metrics 可选 | 指标和变体列表 | < reports.metric_variants > array |
plots
| 名称 | 描述 | Schema |
|---|---|---|
| iters 可选 | 返回图表的最新迭代的最大数量 | integer |
| last_iters_per_task_metric 可选 | 如果设置为 'true' 且 iters 已传递，则检索每个任务指标的最后几次迭代。否则检索整个任务的最后几次迭代 默认 : true | boolean |
| metrics 可选 | 指标和变体列表 | < reports.metric_variants > array |
scalar_metrics_iter_histogram
| 名称 | 描述 | Schema |
|---|---|---|
| key 可选 | 要使用的直方图 x 轴 iter - 迭代次数 iso_time - 以 ISO 格式字符串表示的事件时间 timestamp - 事件时间戳，以自 epoch 以来的毫秒表示 | reports.scalar_key_enum |
| metrics 可选 | 指标和变体列表 | < reports.metric_variants > array |
| samples 可选 | 要返回的直方图点数量（0 表示返回所有点）。可选，默认值为 6000。 | integer |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| debug_images 可选 | 按任务和迭代分组的调试图像事件 | < reports.debug_images_response_task_metrics > array |
| plots 可选 | 按指标、变体、任务和迭代映射的图表 | object |
| scalar_metrics_iter_histogram 可选 | object | |
| single_value_metrics 可选 | 按任务分组的单值指标 | < reports.single_value_task_metrics > array |
| tasks 可选 | 任务列表 | < reports.task > array |
POST /reports.move
描述
将报告移动到项目
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| project 可选 | 目标项目 ID。如果未提供，必须提供 project_name。根项目使用 nullfor the root project | string |
| project_name 可选 | 目标项目名称。如果提供且名称为该名称的项目不存在，将创建一个 新项目。如果未提供，必须提供 project。 | string |
| task 必填 | 要移动的报告 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| project_id 可选 | 目标项目 ID | string |
POST /reports.publish
描述
发布报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| comment 可选 | 客户端消息 | string |
| task 必填 | 要发布的报告任务 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| fields 可选 | 更新的字段名称和值 | object |
| updated 可选 | 已更新的报告数量 (0 或 1) | integer |
POST /reports.unarchive
描述
取消归档报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| comment 可选 | 客户端消息 | string |
| task 必填 | 要取消归档的报告任务 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| unarchived 可选 | 已取消归档的报告数量 (0 或 1) | integer |
POST /reports.update
描述
创建新报告
参数
| 类型 | 名称 | 描述 | Schema |
|---|---|---|---|
| 请求体 | request 必填 | 请求体 | request |
request
| 名称 | 描述 | Schema |
|---|---|---|
| comment 可选 | 自由文本注释 | string |
| name 可选 | 报告名称。在公司内唯一。 | string |
| report 可选 | 报告模板 | string |
| report_assets 可选 | 外部报告资产列表 | < string > array |
| tags 可选 | 用户定义的标签列表 | < string > array |
| task 必填 | 要更新的报告任务 ID | string |
响应
| HTTP 码 | Schema |
|---|---|
| 200 | 响应 200 |
响应 200
| 名称 | 描述 | Schema |
|---|---|---|
| fields 可选 | 更新的字段名称和值 | object |
| updated 可选 | 已更新的报告数量 (0 或 1) | integer |