REST API

MLflow REST API 允许您创建、列出和获取实验和运行，并记录参数、指标和工件。API 托管在 MLflow 跟踪服务器的 /api 路由下。例如，要在托管在 https://:5000 的跟踪服务器上搜索实验，请向 https://:5000/api/2.0/mlflow/experiments/search 发送 POST 请求。

---

创建实验

端点	HTTP 方法
2.0/mlflow/experiments/create	POST

使用名称创建实验。返回新创建实验的 ID。验证同一名称的实验尚不存在，如果同一名称的实验已存在，则失败。

如果给定名称的实验已存在，则会抛出 RESOURCE_ALREADY_EXISTS。

请求结构

字段名称	类型	描述
name	STRING	实验名称。此字段是必需的。
artifact_location	STRING	存储实验所有工件的位置。如果未提供，远程服务器将选择一个合适的默认值。
tags	一个 ExperimentTag 数组	一组要设置在实验上的标签。每个请求的最大标签大小和标签数量取决于存储后端。所有存储后端均保证支持最大 250 字节的标签键和最大 5000 字节的标签值。所有存储后端还保证每个请求支持最多 20 个标签。

响应结构

字段名称	类型	描述
experiment_id	STRING	实验的唯一标识符。

---

搜索实验

端点	HTTP 方法
2.0/mlflow/experiments/search	POST

请求结构

字段名称	类型	描述
max_results	INT64	期望的最大实验数量。服务器可以选择一个期望的默认 max_results 值。所有服务器都保证支持至少 1,000 的 max_results 阈值，但可能支持更多。此端点的调用者应显式传递 max_results 并利用 page_token 来迭代实验。
page_token	STRING	指示要获取的实验页面的令牌
filter	STRING	一个用于实验属性和标签的过滤表达式，允许返回实验的子集。语法是 SQL 的子集，支持在属性或标签与常量之间进行 AND 运算。 示例： name LIKE 'test-%' AND tags.key = 'value' 您可以使用双引号或反引号来选择带有特殊字符（连字符、空格、句点等）的列。 示例： tags."extra-key" = 'value' 或 tags.`extra-key` = 'value' 支持的运算符是 =、!=、LIKE 和 ILIKE。
order_by	一个 STRING 数组	用于对搜索结果进行排序的列列表，可以包括实验名称和 ID，以及可选的“DESC”或“ASC”注释，“ASC”是默认值。平局通过实验 ID DESC 进行。
view_type	ViewType	要返回的实验类型的限定符。如果未指定，则仅返回活动实验。

响应结构

字段名称	类型	描述
experiments	一个 Experiment 数组	与搜索条件匹配的实验
next_page_token	STRING	可用于检索下一页实验的令牌。空令牌表示没有更多可用实验。

---

获取实验

端点	HTTP 方法
2.0/mlflow/experiments/get	GET

获取实验的元数据。此方法适用于已删除的实验。

请求结构

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段是必需的。

响应结构

字段名称	类型	描述
experiment	Experiment	实验详细信息。

---

按名称获取实验

端点	HTTP 方法
2.0/mlflow/experiments/get-by-name	GET

获取实验的元数据。

此端点将返回已删除的实验，但在活动实验和已删除实验共享同一名称时，它会优先返回活动实验。如果多个已删除实验共享同一名称，API 将返回其中一个。

如果不存在指定名称的实验，则会抛出 RESOURCE_DOES_NOT_EXIST。

请求结构

字段名称	类型	描述
experiment_name	STRING	关联实验的名称。此字段是必需的。

响应结构

字段名称	类型	描述
experiment	Experiment	实验详细信息。

---

删除实验

端点	HTTP 方法
2.0/mlflow/experiments/delete	POST

标记实验及其关联的元数据、运行、指标、参数和标签为待删除。如果实验使用 FileStore，则实验相关的工件也会被删除。

请求结构

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段是必需的。

---

恢复实验

端点	HTTP 方法
2.0/mlflow/experiments/restore	POST

恢复标记为待删除的实验。这也将恢复关联的元数据、运行、指标、参数和标签。如果实验使用 FileStore，则实验相关的底层工件也将被恢复。

如果实验从未创建或已永久删除，则会抛出 RESOURCE_DOES_NOT_EXIST。

请求结构

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段是必需的。

---

更新实验

端点	HTTP 方法
2.0/mlflow/experiments/update	POST

更新实验元数据。

请求结构

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段是必需的。
new_name	STRING	如果提供，实验的名称将更改为新名称。新名称必须是唯一的。

---

创建运行

端点	HTTP 方法
2.0/mlflow/runs/create	POST

在实验中创建新运行。运行通常是机器学习或数据 ETL 管道的单个执行。MLflow 使用运行来跟踪与单个执行关联的 Param、Metric 和 RunTag。

请求结构

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。
user_id	STRING	执行运行的用户 ID。此字段自 MLflow 1.0 起已弃用，将在未来的 MLflow 版本中删除。请改用“mlflow.user”标签。
run_name	STRING	运行的名称。
start_time	INT64	运行开始时间的 Unix 时间戳（毫秒）。
tags	一个 RunTag 数组	运行的附加元数据。

响应结构

字段名称	类型	描述
run	Run	新创建的运行。

---

删除运行

端点	HTTP 方法
2.0/mlflow/runs/delete	POST

标记运行为待删除。

请求结构

字段名称	类型	描述
run_id	STRING	要删除的运行的 ID。此字段是必需的。

---

恢复运行

端点	HTTP 方法
2.0/mlflow/runs/restore	POST

恢复已删除的运行。

请求结构

字段名称	类型	描述
run_id	STRING	要恢复的运行的 ID。此字段是必需的。

---

获取运行

端点	HTTP 方法
2.0/mlflow/runs/get	GET

获取运行的元数据、指标、参数和标签。在运行中记录了具有相同键的多个指标的情况下，只返回具有最新时间戳的值。如果存在多个具有最新时间戳的值，则返回这些值中的最大值。

请求结构

字段名称	类型	描述
run_id	STRING	要获取的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要获取的运行的 ID。此字段将在未来的 MLflow 版本中删除。

响应结构

字段名称	类型	描述
run	Run	运行元数据（名称、开始时间等）和数据（指标、参数和标签）。

---

记录指标

端点	HTTP 方法
2.0/mlflow/runs/log-metric	POST

为运行记录一个指标。指标是键值对（字符串键、浮点值）并带有时间戳。例如，表示 ML 模型准确度的各种指标。一个指标可以被记录多次。

请求结构

字段名称	类型	描述
run_id	STRING	要记录指标的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要记录指标的运行的 ID。此字段将在未来的 MLflow 版本中删除。
key	STRING	指标的名称。此字段是必需的。
value	DOUBLE	要记录的指标的浮点值。此字段是必需的。
timestamp	INT64	记录指标时的 Unix 时间戳（毫秒）。此字段是必需的。
step	INT64	记录指标的步长

---

批量记录

端点	HTTP 方法
2.0/mlflow/runs/log-batch	POST

为运行记录一批指标、参数和标签。如果任何数据未能持久化，服务器将响应错误（非 200 状态码）。在发生错误时（由于内部服务器错误或无效请求），可能会写入部分数据。

您可以以交错的方式写入指标、参数和标签，但在给定实体类型内，保证按照请求正文中指定的顺序进行。也就是说，对于一个 API 请求，如

{
   "run_id": "2a14ed5c6a87499199e0106c3501eab8",
   "metrics": [
     {"key": "mae", "value": 2.5, "timestamp": 1552550804},
     {"key": "rmse", "value": 2.7, "timestamp": 1552550804},
   ],
   "params": [
     {"key": "model_class", "value": "LogisticRegression"},
   ]
}

服务器保证在“mae”之后写入指标“rmse”，尽管它可能在两个指标之前、在“mae”之后或在两个指标之后写入参数“model_class”。

指标、参数和标签的覆盖行为如下：

• 指标：指标值永远不会被覆盖。记录一个指标（键、值、时间戳）会追加到具有给定键的指标的值集中。

• 标签：标签值可以被后续对同一标签键的写入覆盖。也就是说，如果在同一个 API 请求中提供了具有相同键的多个标签值，则会写入最后提供的标签值。允许记录相同的标签（键、值）——也就是说，记录标签是幂等的。

• 参数：一旦写入，参数值就不能被更改（尝试覆盖参数值将导致错误）。但是，允许记录相同的参数（键、值）——也就是说，记录参数是幂等的。

请求限制

单个 JSON 序列化的 API 请求大小最多为 1 MB，并且包含

• 总共不超过 1000 个指标、参数和标签

• 最多 1000 个指标

• 最多 100 个参数

• 最多 100 个标签

例如，一个有效的请求可能包含 900 个指标、50 个参数和 50 个标签，但记录 900 个指标、50 个参数和 51 个标签是无效的。以下限制也适用于指标、参数和标签的键和值：

• 指标、参数和标签的键最多可以为 250 个字符

• 参数和标签的值最多可以为 250 个字符

请求结构

字段名称	类型	描述
run_id	STRING	要记录的运行的 ID
metrics	一个 Metric 数组	要记录的指标。单个请求最多可包含 1000 个指标，以及最多 1000 个指标、参数和标签。
params	一个 Param 数组	要记录的参数。单个请求最多可包含 100 个参数，以及最多 1000 个指标、参数和标签。
tags	一个 RunTag 数组	要记录的标签。单个请求最多可包含 100 个标签，以及最多 1000 个指标、参数和标签。

---

记录模型

端点	HTTP 方法
2.0/mlflow/runs/log-model	POST

注意

实验性：此 API 在未来版本中可能会更改或删除，恕不另行通知。

请求结构

字段名称	类型	描述
run_id	STRING	要记录的运行的 ID
model_json	STRING	MLmodel 文件（JSON 格式）。

---

记录输入

端点	HTTP 方法
2.0/mlflow/runs/log-inputs	POST

请求结构

字段名称	类型	描述
run_id	STRING	要记录的运行的 ID。此字段是必需的。
datasets	一个 DatasetInput 数组	数据集输入

---

设置实验标签

端点	HTTP 方法
2.0/mlflow/experiments/set-experiment-tag	POST

为实验设置标签。实验标签是可更新的元数据。

请求结构

字段名称	类型	描述
experiment_id	STRING	要记录标签的实验的 ID。必须提供。此字段是必需的。
key	STRING	标签的名称。最大大小取决于存储后端。所有存储后端都保证支持最大 250 字节的键值。此字段是必需的。
value	STRING	要记录的标签的字符串值。最大大小取决于存储后端。所有存储后端都保证支持最大 5000 字节的键值。此字段是必需的。

---

删除实验标签

端点	HTTP 方法
2.0/mlflow/experiments/delete-experiment-tag	POST

删除实验上的标签。

请求结构

字段名称	类型	描述
experiment_id	STRING	标签被记录的实验的 ID。必须提供。此字段是必需的。
key	STRING	标签的名称。最大大小为 255 字节。必须提供。此字段是必需的。

---

设置标签

端点	HTTP 方法
2.0/mlflow/runs/set-tag	POST

为运行设置标签。标签是在运行期间和运行完成后可更新的运行元数据。

请求结构

字段名称	类型	描述
run_id	STRING	要记录标签的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要记录标签的运行的 ID。此字段将在未来的 MLflow 版本中删除。
key	STRING	标签的名称。最大大小取决于存储后端。所有存储后端都保证支持最大 250 字节的键值。此字段是必需的。
value	STRING	要记录的标签的字符串值。最大大小取决于存储后端。所有存储后端都保证支持最大 5000 字节的键值。此字段是必需的。

---

删除标签

端点	HTTP 方法
2.0/mlflow/runs/delete-tag	POST

删除运行上的标签。标签是在运行期间和运行完成后可更新的运行元数据。

请求结构

字段名称	类型	描述
run_id	STRING	被标记的运行的 ID。必须提供。此字段是必需的。
key	STRING	标签的名称。最大大小为 255 字节。必须提供。此字段是必需的。

---

记录参数

端点	HTTP 方法
2.0/mlflow/runs/log-parameter	POST

为运行记录一个参数。参数是键值对（字符串键、字符串值）。例如，包括 ML 模型训练使用的超参数和 ETL 管道使用的常量日期和值。参数只能为运行记录一次。

请求结构

字段名称	类型	描述
run_id	STRING	要记录参数的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要记录参数的运行的 ID。此字段将在未来的 MLflow 版本中删除。
key	STRING	参数的名称。最大大小为 255 字节。此字段是必需的。
value	STRING	要记录的参数的字符串值。最大大小为 6000 字节。此字段是必需的。

---

获取指标历史记录

端点	HTTP 方法
2.0/mlflow/metrics/get-history	GET

获取给定运行中指定指标的所有值的列表。

请求结构

字段名称	类型	描述
run_id	STRING	要从中获取指标值的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要从中获取指标值的运行的 ID。此字段将在未来的 MLflow 版本中删除。
metric_key	STRING	指标的名称。此字段是必需的。
page_token	STRING	指示要获取的指标历史页面的令牌
max_results	INT32	每次调用要返回的运行中记录的指标的最大实例数。后端服务器可能会根据性能要求限制 max_results 的值。不指定此值的请求将表现为非分页查询，其中运行中给定指标的所有指标历史值将在单个响应中返回。

响应结构

字段名称	类型	描述
metrics	一个 Metric 数组	此指标的所有记录值。
next_page_token	STRING	可用于发出查询以获取下一页指标历史值的令牌。缺失的令牌表示没有更多可用指标可获取。

---

搜索运行

端点	HTTP 方法
2.0/mlflow/runs/search	POST

搜索满足表达式的运行。搜索表达式可以使用 Metric 和 Param 键。

请求结构

字段名称	类型	描述
experiment_ids	一个 STRING 数组	要搜索的实验 ID 列表。
filter	STRING	一个用于参数、指标和标签的过滤表达式，允许返回运行的子集。语法是 SQL 的子集，支持在参数、指标或标签与常量之间进行 AND 运算。 示例： metrics.rmse < 1 and params.model_class = 'LogisticRegression' 您可以使用双引号选择带有特殊字符（连字符、空格、句点等）的列： metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas' 支持的运算符是 =、!=、>、>=、< 和 <=。
run_view_type	ViewType	是要仅显示活动运行、仅显示已删除运行还是显示所有运行。默认为仅显示活动运行。
max_results	INT32	期望的最大运行数量。如果未指定，默认为 1000。所有服务器都保证支持至少 50,000 的 max_results 阈值，但可能支持更多。此端点的调用者应显式传递 max_results 并利用 page_token 来迭代实验。
order_by	一个 STRING 数组	要排序的列列表，包括属性、参数、指标和标签，以及可选的“DESC”或“ASC”注释，“ASC”是默认值。示例：[“params.input DESC”, “metrics.alpha ASC”, “metrics.rmse”] 平局通过 start_time DESC 进行，然后是具有相同 start_time 的运行的 run_id（如果未提供 order_by，则这是默认排序标准）。
page_token	STRING

响应结构

字段名称	类型	描述
runs	一个 Run 数组	与搜索条件匹配的运行。
next_page_token	STRING

---

列出工件

端点	HTTP 方法
2.0/mlflow/artifacts/list	GET

列出运行的工件。接受一个可选的 artifact_path 前缀，如果指定了该前缀，响应将仅包含具有该指定前缀的工件。

请求结构

字段名称	类型	描述
run_id	STRING	要列出工件的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要列出工件的运行的 ID。此字段将在未来的 MLflow 版本中删除。
path	STRING	过滤与此路径匹配的工件（相对于根工件目录的路径）。
page_token	STRING	指示要获取的工件结果页面的令牌

响应结构

字段名称	类型	描述
root_uri	STRING	运行的根工件目录。
files	一个 FileInfo 数组	工件的文件位置和元数据。
next_page_token	STRING	可用于检索下一页工件结果的令牌

---

更新运行

端点	HTTP 方法
2.0/mlflow/runs/update	POST

更新运行元数据。

请求结构

字段名称	类型	描述
run_id	STRING	要更新的运行的 ID。必须提供。
run_uuid	STRING	[已弃用，请使用 run_id] 要更新的运行的 ID。此字段将在未来的 MLflow 版本中删除。
status	RunStatus	运行的更新状态。
end_time	INT64	运行结束时间的 Unix 时间戳（毫秒）。
run_name	STRING	运行的更新名称。

响应结构

字段名称	类型	描述
run_info	RunInfo	运行的更新元数据。

---

列出评分器

端点	HTTP 方法
2.0/mlflow/scorers/list	GET

列出实验的所有评分器。

请求结构

列出实验的所有评分器。

字段名称	类型	描述
experiment_id	STRING	实验 ID。

响应结构

字段名称	类型	描述
scorers	一个 Scorer 数组	评分器实体列表（每个评分器名称的最新版本）。

---

列出评分器版本

端点	HTTP 方法
2.0/mlflow/scorers/versions	GET

列出实验的特定评分器的所有版本。

请求结构

列出实验的特定评分器的所有版本。

字段名称	类型	描述
experiment_id	STRING	实验 ID。
name	STRING	评分器的名称。

响应结构

字段名称	类型	描述
scorers	一个 Scorer 数组	评分器的所有版本的评分器实体列表。

---

注册评分器

端点	HTTP 方法
2.0/mlflow/scorers/register	POST

为实验注册评分器。

请求结构

为实验注册评分器。

字段名称	类型	描述
experiment_id	STRING	实验 ID。
name	STRING	评分器的名称。
serialized_scorer	STRING	序列化的评分器字符串（JSON）。

响应结构

字段名称	类型	描述
version	INT32	评分器的新版本号。
scorer_id	STRING	评分器的唯一标识符。
experiment_id	STRING	实验 ID（与请求相同）。
name	STRING	评分器名称（与请求相同）。
serialized_scorer	STRING	序列化的评分器字符串（与请求相同）。
creation_time	INT64	评分器版本的创建时间（自纪元以来以毫秒为单位）。

---

获取评分器

端点	HTTP 方法
2.0/mlflow/scorers/get	GET

获取实验的特定评分器。

请求结构

获取实验的特定评分器。

字段名称	类型	描述
experiment_id	STRING	实验 ID。
name	STRING	评分器的名称。
version	INT32	评分器版本。如果未指定，则返回具有最大版本的评分器。

响应结构

字段名称	类型	描述
scorer	评分器	评分器实体。

---

删除评分器

端点	HTTP 方法
2.0/mlflow/scorers/delete	DELETE

删除实验的评分器。

请求结构

删除实验的评分器。

字段名称	类型	描述
experiment_id	STRING	实验 ID。
name	STRING	评分器的名称。
version	INT32	要删除的评分器版本。如果未指定，则删除所有版本。

---

创建网关端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/create	POST

创建带有模型配置的新端点

请求结构

字段名称	类型	描述
name	STRING	端点的可选用户友好名称
model_definition_ids	一个 STRING 数组	要附加到此端点的模型定义 ID 列表
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
endpoint	GatewayEndpoint	已创建的端点及其所有模型映射

---

更新网关端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/update	POST

更新端点的名称

请求结构

字段名称	类型	描述
endpoint_id	STRING	要更新的端点的 ID
name	STRING	端点的可选新名称
updated_by	STRING	更新者的用户名

响应结构

字段名称	类型	描述
endpoint	GatewayEndpoint	已更新的端点

---

删除网关端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/delete	DELETE

删除端点及其所有模型配置

请求结构

字段名称	类型	描述
endpoint_id	STRING	要删除的端点的 ID

---

获取网关端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/get	GET

获取端点详细信息，包括所有模型配置

请求结构

字段名称	类型	描述
endpoint_id	STRING	必须提供 endpoint_id 或 name
name	STRING

响应结构

字段名称	类型	描述
endpoint	GatewayEndpoint	包含所有模型配置的端点

---

列出网关端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/list	GET

列出端点，可按提供商或 secret 进行过滤

请求结构

字段名称	类型	描述
provider	STRING	按提供商过滤（可选）
secret_id	STRING	按 secret ID 过滤（可选）

响应结构

字段名称	类型	描述
endpoints	一个 GatewayEndpoint 数组	包含其模型配置的端点列表

---

创建端点绑定

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/bindings/create	POST

创建端点与 MLflow 资源的绑定

请求结构

字段名称	类型	描述
endpoint_id	STRING	要绑定的端点 ID
resource_type	STRING	MLflow 资源类型
resource_id	STRING	资源实例 ID
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
binding	GatewayEndpointBinding	创建的绑定

---

删除端点绑定

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/bindings/delete	DELETE

删除端点与资源的绑定

请求结构

字段名称	类型	描述
endpoint_id	STRING	端点 ID
resource_type	STRING	绑定到端点的资源类型
resource_id	STRING	资源 ID

---

列出端点绑定

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/bindings/list	GET

列出端点的所有绑定

请求结构

字段名称	类型	描述
endpoint_id	STRING	要列出绑定的端点 ID
resource_type	STRING	用于过滤绑定的资源类型（例如，“scorer_job”）
resource_id	STRING	用于过滤绑定的资源 ID

响应结构

字段名称	类型	描述
bindings	一个 GatewayEndpointBinding 数组	端点的绑定列表

---

创建网关模型定义

端点	HTTP 方法
2.0/mlflow/gateway/model-definitions/create	POST

创建可重用的模型定义

请求结构

字段名称	类型	描述
name	STRING	模型定义的友好名称（必须唯一）
secret_id	STRING	包含身份验证凭据的 secret 的 ID
provider	STRING	LLM 提供商（例如，“openai”、“anthropic”）
model_name	STRING	提供商特定的模型标识符（例如，“gpt-4o”、“claude-3-5-sonnet”）
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
model_definition	GatewayModelDefinition	创建的模型定义

---

更新网关模型定义

端点	HTTP 方法
2.0/mlflow/gateway/model-definitions/update	POST

更新模型定义

请求结构

字段名称	类型	描述
model_definition_id	STRING	要更新的模型定义的 ID
name	STRING	新名称（可选）
secret_id	STRING	新 secret ID（可选）
model_name	STRING	新模型名称（可选）
updated_by	STRING	更新者的用户名
provider	STRING	新提供商（可选）

响应结构

字段名称	类型	描述
model_definition	GatewayModelDefinition	更新后的模型定义

---

删除网关模型定义

端点	HTTP 方法
2.0/mlflow/gateway/model-definitions/delete	DELETE

删除模型定义（如果被任何端点使用则失败）

请求结构

字段名称	类型	描述
model_definition_id	STRING	要删除的模型定义的 ID（如果被任何端点使用则失败）

---

获取网关模型定义

端点	HTTP 方法
2.0/mlflow/gateway/model-definitions/get	GET

按 ID 获取模型定义

请求结构

字段名称	类型	描述
model_definition_id	STRING	要检索的模型定义的 ID

响应结构

字段名称	类型	描述
model_definition	GatewayModelDefinition	模型定义

---

列出网关模型定义

端点	HTTP 方法
2.0/mlflow/gateway/model-definitions/list	GET

列出所有模型定义，可进行可选过滤

请求结构

字段名称	类型	描述
provider	STRING	按提供商过滤（可选）
secret_id	STRING	按 secret ID 过滤（可选）

响应结构

字段名称	类型	描述
model_definitions	一个 GatewayModelDefinition 数组	模型定义列表

---

创建网关 Secret

端点	HTTP 方法
2.0/mlflow/gateway/secrets/create	POST

创建新的加密 secret，用于 LLM 提供商身份验证

请求结构

字段名称	类型	描述
secret_name	STRING	Secret 的友好名称（必须唯一）
secret_value	一个 SecretValueEntry 数组	要加密的 Secret 值（键值对）。对于简单的 API 密钥：{“api_key”: “sk-xxx”} 对于复合凭据：{“aws_access_key_id”: “…”, “aws_secret_access_key”: “…”}
provider	STRING	LLM 提供商（例如，“openai”、“anthropic”）
auth_config_json	STRING	提供商特定的身份验证配置（JSON 字符串，可选）。对于多重身份验证提供商，请包含“auth_mode”键（例如，{“auth_mode”: “access_keys”, “aws_region_name”: “us- east-1”}）
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
secret	GatewaySecretInfo	创建的 secret 元数据（不包含加密值）

---

更新网关 Secret

端点	HTTP 方法
2.0/mlflow/gateway/secrets/update	POST

更新现有 secret 的值或身份验证配置

请求结构

字段名称	类型	描述
secret_id	STRING	要更新的 secret 的 ID
secret_value	一个 SecretValueEntry 数组	用于密钥轮换的新 secret 值（键值对，可选）（空映射 = 不更改）。对于简单的 API 密钥：{“api_key”: “sk-xxx”} 对于复合凭据：{“aws_access_key_id”: “…”, “aws_secret_access_key”: “…”}
auth_config_json	STRING	新的身份验证配置（JSON 字符串，可选）。对于多重身份验证提供商，请包含“auth_mode”键（例如，{“auth_mode”: “access_keys”, “aws_region_name”: “us- east-1”}）
updated_by	STRING	更新者的用户名

响应结构

字段名称	类型	描述
secret	GatewaySecretInfo	更新后的 secret 元数据

---

删除网关 Secret

端点	HTTP 方法
2.0/mlflow/gateway/secrets/delete	DELETE

删除 secret

请求结构

字段名称	类型	描述
secret_id	STRING	要删除的 secret 的 ID

---

获取网关 Secret 信息

端点	HTTP 方法
2.0/mlflow/gateway/secrets/get	GET

获取 secret 的元数据（不包含解密的 secret 值）

请求结构

字段名称	类型	描述
secret_id	STRING	必须提供 secret_id 或 secret_name
secret_name	STRING

响应结构

字段名称	类型	描述
secret	GatewaySecretInfo	Secret 元数据（不包含加密值）

---

列出网关 Secret

端点	HTTP 方法
2.0/mlflow/gateway/secrets/list	GET

列出所有 secret，可按提供商过滤

请求结构

字段名称	类型	描述
provider	STRING	按提供商过滤（例如，“openai”、“anthropic”，可选）

响应结构

字段名称	类型	描述
secrets	一个 GatewaySecretInfo 数组	Secret 元数据列表（不包含加密值）

---

将模型附加到端点

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/models/attach	POST

将现有模型定义附加到端点

请求结构

字段名称	类型	描述
endpoint_id	STRING	要将模型附加到的端点 ID
model_definition_id	STRING	要附加的模型定义的 ID
weight	FLOAT	路由权重（可选，默认为 1）
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
mapping	GatewayEndpointModelMapping	创建的映射

---

从端点分离模型

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/models/detach	POST

从端点分离模型定义（不删除模型定义）

请求结构

字段名称	类型	描述
endpoint_id	STRING	端点 ID
model_definition_id	STRING	要分离的模型定义的 ID

---

设置网关端点标签

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/set-tag	POST

在端点上设置标签

请求结构

字段名称	类型	描述
endpoint_id	STRING	要设置标签的端点 ID
key	STRING	要设置的标签键
value	STRING	要设置的标签值

---

删除网关端点标签

端点	HTTP 方法
2.0/mlflow/gateway/endpoints/delete-tag	DELETE

从端点删除标签

请求结构

字段名称	类型	描述
endpoint_id	STRING	要删除标签的端点 ID
key	STRING	要删除的标签键

---

创建已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/create	POST

如果具有给定名称的已注册模型已存在，则抛出 RESOURCE_ALREADY_EXISTS。

请求结构

字段名称	类型	描述
name	STRING	在此名称下注册模型。此字段是必需的。
tags	一个 RegisteredModelTag 数组	已注册模型的附加元数据。
description	STRING	已注册模型的描述（可选）。
deployment_job_id	STRING	此模型的部署作业 ID。

响应结构

字段名称	类型	描述
registered_model	RegisteredModel

---

获取已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/get	GET

请求结构

字段名称	类型	描述
name	STRING	已注册模型的唯一名称标识符。此字段是必需的。

响应结构

字段名称	类型	描述
registered_model	RegisteredModel

---

重命名已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/rename	POST

请求结构

字段名称	类型	描述
name	STRING	已注册模型的唯一名称标识符。此字段是必需的。
new_name	STRING	如果提供，将更新此 registered_model 的名称。

响应结构

字段名称	类型	描述
registered_model	RegisteredModel

---

更新已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/update	PATCH

请求结构

字段名称	类型	描述
name	STRING	已注册模型的唯一名称标识符。此字段是必需的。
description	STRING	如果提供，将更新此 registered_model 的描述。
deployment_job_id	STRING	此模型的部署作业 ID。

响应结构

字段名称	类型	描述
registered_model	RegisteredModel

---

删除已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/delete	DELETE

请求结构

字段名称	类型	描述
name	STRING	已注册模型的唯一名称标识符。此字段是必需的。

---

获取最新模型版本

端点	HTTP 方法
2.0/mlflow/registered-models/get-latest-versions	POST

请求结构

字段名称	类型	描述
name	STRING	已注册模型的唯一名称标识符。此字段是必需的。
stages	一个 STRING 数组	阶段列表。

响应结构

字段名称	类型	描述
model_versions	一个 ModelVersion 数组	每个请求阶段的最新版本模型。仅返回当前 READY 状态的模型。如果未提供 stages，则返回每个阶段的最新版本，包括 "None"。

---

创建模型版本

端点	HTTP 方法
2.0/mlflow/model-versions/create	POST

请求结构

字段名称	类型	描述
name	STRING	在此名称下注册模型。此字段是必需的。
source	STRING	指示模型工件位置的 URI。此字段是必需的。
run_id	STRING	MLflow 运行 ID 用于关联，如果 source 是由 MLflow 跟踪服务器中的实验运行生成的
tags	一个 ModelVersionTag 数组	模型版本的附加元数据。
run_link	STRING	MLflow 运行链接 - 这是生成此模型版本的运行的精确链接，可能托管在另一个 MLflow 实例上。
description	STRING	模型版本的描述（可选）。
model_id	STRING	模型版本的 model_id（可选），用于将已注册模型链接到源记录模型

响应结构

字段名称	类型	描述
model_version	ModelVersion	返回注册表中为此模型生成的新版本号。

---

获取模型版本

端点	HTTP 方法
2.0/mlflow/model-versions/get	GET

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。

响应结构

字段名称	类型	描述
model_version	ModelVersion

---

更新模型版本

端点	HTTP 方法
2.0/mlflow/model-versions/update	PATCH

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。
description	STRING	如果提供，将更新此 registered_model 的描述。

响应结构

字段名称	类型	描述
model_version	ModelVersion	返回注册表中为此模型生成的新版本号。

---

删除模型版本

端点	HTTP 方法
2.0/mlflow/model-versions/delete	DELETE

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。

---

搜索模型版本

端点	HTTP 方法
2.0/mlflow/model-versions/search	GET

请求结构

字段名称	类型	描述
filter	STRING	过滤条件字符串，例如“name='my-model-name'”。必须是单个布尔条件，字符串值用单引号括起来。
max_results	INT64	所需的模型最大数量。最大阈值为 200K。后端可以选择较低的默认值和最大阈值。
order_by	一个 STRING 数组	按模型名称、版本、阶段排序的列列表，并可选择添加“DESC”或“ASC”注解，其中“ASC”是默认值。平局按最新阶段转换时间戳，然后按名称 ASC，然后按版本 DESC 进行。
page_token	STRING	用于基于先前搜索查询转到下一页的分页标记。

响应结构

字段名称	类型	描述
model_versions	一个 ModelVersion 数组	匹配搜索条件的模型
next_page_token	STRING	用于对同一搜索查询请求下一页模型的 ist_page 分页标记。

---

获取模型版本工件的下载 URI

端点	HTTP 方法
2.0/mlflow/model-versions/get-download-uri	GET

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。

响应结构

字段名称	类型	描述
artifact_uri	STRING	存储此模型版本工件的 URI。

---

转换模型版本阶段

端点	HTTP 方法
2.0/mlflow/model-versions/transition-stage	POST

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。
stage	STRING	将 model_version 转换为新阶段。此字段是必需的。
archive_existing_versions	BOOL	将模型版本转换为特定阶段时，此标志决定是否应将该阶段的所有现有模型版本原子地移至“已存档”阶段。这可确保在目标阶段最多存在一个模型版本。转换为模型版本的阶段时，此字段是*必需*的。此字段是必需的。

响应结构

字段名称	类型	描述
model_version	ModelVersion	更新后的模型版本

---

搜索已注册模型

端点	HTTP 方法
2.0/mlflow/registered-models/search	GET

请求结构

字段名称	类型	描述
filter	STRING	过滤条件字符串，例如“name LIKE ‘my-model-name’”。在后端自动解释为“name LIKE ‘%my-model-name%’”。单个布尔条件，字符串值用单引号括起来。
max_results	INT64	所需的模型最大数量。默认为 100。最大阈值为 1000。
order_by	一个 STRING 数组	用于排序搜索结果的列列表，包括模型名称和最后更新时间戳，并可选择添加“DESC”或“ASC”注解，其中“ASC”是默认值。平局按模型名称 ASC 进行。
page_token	STRING	用于根据先前的搜索查询转到下一页的分页标记。

响应结构

字段名称	类型	描述
registered_models	一个 RegisteredModel 数组	匹配搜索条件的已注册模型。
next_page_token	STRING	用于请求下一页模型的 ist_page 分页标记。

---

设置已注册模型标签

端点	HTTP 方法
2.0/mlflow/registered-models/set-tag	POST

请求结构

字段名称	类型	描述
name	STRING	模型的唯一名称。此字段是必需的。
key	STRING	标签名称。最大大小取决于存储后端。如果具有此名称的标签已存在，其先前的值将被指定的 value 替换。所有存储后端都保证支持高达 250 字节大小的键值。此字段是必需的。
value	STRING	正在记录的标签的字符串值。最大大小取决于存储后端。此字段是必需的。

---

设置模型版本标签

端点	HTTP 方法
2.0/mlflow/model-versions/set-tag	POST

请求结构

字段名称	类型	描述
name	STRING	模型的唯一名称。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。
key	STRING	标签名称。最大大小取决于存储后端。如果具有此名称的标签已存在，其先前的值将被指定的 value 替换。所有存储后端都保证支持高达 250 字节大小的键值。此字段是必需的。
value	STRING	正在记录的标签的字符串值。最大大小取决于存储后端。此字段是必需的。

---

删除已注册模型标签

端点	HTTP 方法
2.0/mlflow/registered-models/delete-tag	DELETE

请求结构

字段名称	类型	描述
name	STRING	记录标签的已注册模型的名称。此字段是必需的。
key	STRING	标签名称。名称必须完全匹配；不支持通配符删除。最大大小为 250 字节。此字段是必需的。

---

删除模型版本标签

端点	HTTP 方法
2.0/mlflow/model-versions/delete-tag	DELETE

请求结构

字段名称	类型	描述
name	STRING	记录标签的已注册模型的名称。此字段是必需的。
version	STRING	记录标签的模型版本号。此字段是必需的。
key	STRING	标签名称。名称必须完全匹配；不支持通配符删除。最大大小为 250 字节。此字段是必需的。

---

删除已注册模型别名

端点	HTTP 方法
2.0/mlflow/registered-models/alias	DELETE

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
alias	STRING	别名名称。名称必须完全匹配；不支持通配符删除。最大大小为 256 字节。此字段是必需的。

---

按别名获取模型版本

端点	HTTP 方法
2.0/mlflow/registered-models/alias	GET

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
alias	STRING	别名名称。最大大小为 256 字节。此字段是必需的。

响应结构

字段名称	类型	描述
model_version	ModelVersion

---

设置已注册模型别名

端点	HTTP 方法
2.0/mlflow/registered-models/alias	POST

请求结构

字段名称	类型	描述
name	STRING	已注册模型的名称。此字段是必需的。
alias	STRING	别名名称。最大大小取决于存储后端。如果具有此名称的别名已存在，其先前的值将被指定的 version 替换。所有存储后端都保证支持高达 256 字节大小的别名名称值。此字段是必需的。
version	STRING	模型版本号。此字段是必需的。

数据结构

Dataset

Dataset。表示在模型开发过程中用于训练、测试或评估的数据的引用。

字段名称	类型	描述
name	STRING	数据集的名称。例如“my.uc.table@2” “nyc-taxi-dataset”, “fantastic-elk-3” 此字段是必需的。
digest	STRING	数据集摘要，例如数据集的 md5 哈希，可在相同名称的数据集中唯一标识它。此字段是必需的。
source_type	STRING	数据集源的类型，例如“databricks-uc-table”、“DBFS”、“S3”、... 此字段是必需的。
source	STRING	数据集的源信息。请注意，如果源在与 MLflow 配合使用之前经过转换/修改，则源可能无法精确重现数据集。此字段是必需的。
schema	STRING	数据集的模式。例如，用于数据帧的 MLflow ColSpec JSON，用于 ndarray 的 MLflow TensorSpec JSON，或其他模式格式。
profile	STRING	数据集的概要。数据集的摘要统计信息，例如表中行的数量，表中每个列的平均值/标准差/模式，或数组中的元素数量。

DatasetInput

DatasetInput。表示数据集和输入标签。

字段名称	类型	描述
tags	一个 InputTag 数组	数据集输入的标签列表，例如“context”标签，其值为“training”
dataset	数据集	用作 Run 输入的数据集。此字段是必需的。

Experiment

Experiment

字段名称	类型	描述
experiment_id	STRING	实验的唯一标识符。
name	STRING	标识实验的可读名称。
artifact_location	STRING	存储实验工件的位置。
lifecycle_stage	STRING	实验的当前生命周期阶段：“active”或“deleted”。已删除的实验不会被 API 返回。
last_update_time	INT64	最后更新时间
creation_time	INT64	创建时间
tags	一个 ExperimentTag 数组	Tags: 附加元数据键值对。

ExperimentTag

实验的标签。

字段名称	类型	描述
key	STRING	标签键。
value	STRING	标签值。

FileInfo

字段名称	类型	描述
path	STRING	相对于运行的根工件目录的路径。
is_dir	BOOL	路径是否为目录。
file_size	INT64	大小（字节）。目录未设置。

GatewayEndpoint

表示 LLM 网关端点的端点实体

字段名称	类型	描述
endpoint_id	STRING	端点的唯一标识符
name	STRING	端点的友好名称
created_at	INT64	端点创建时的时间戳（自纪元以来的毫秒数）
last_updated_at	INT64	端点最后更新时的时间戳（自纪元以来的毫秒数）
model_mappings	一个 GatewayEndpointModelMapping 数组	绑定到此端点的模型映射列表
created_by	STRING	创建端点的用户 ID
last_updated_by	STRING	最后更新端点的用户 ID
tags	一个 GatewayEndpointTag 数组	与端点相关的标签

GatewayEndpointBinding

端点与 MLflow 资源的绑定。使用复合键（endpoint_id, resource_type, resource_id）进行标识。

字段名称	类型	描述
endpoint_id	STRING	此绑定引用的端点的 ID
resource_type	STRING	MLflow 资源类型（例如，“scorer_job”）
resource_id	STRING	特定资源实例的 ID
created_at	INT64	绑定创建时的时间戳（自纪元以来的毫秒数）
last_updated_at	INT64	绑定最后更新时的时间戳（自纪元以来的毫秒数）
created_by	STRING	创建绑定的用户 ID
last_updated_by	STRING	最后更新绑定的用户 ID

GatewayEndpointModelMapping

端点与模型定义之间的映射

字段名称	类型	描述
mapping_id	STRING	此映射的唯一标识符
endpoint_id	STRING	端点 ID
model_definition_id	STRING	模型定义的 ID
model_definition	GatewayModelDefinition	完整的模型定义（通过 JOIN 填充）
weight	FLOAT	用于流量分配的路由权重
created_at	INT64	映射创建时的时间戳（自纪元以来的毫秒数）
created_by	STRING	创建映射的用户 ID

GatewayEndpointTag

与端点相关的标签

字段名称	类型	描述
key	STRING	标签键
value	STRING	标签值

GatewayModelDefinition

可跨端点共享的可重用模型定义

字段名称	类型	描述
model_definition_id	STRING	此模型定义的唯一标识符
name	STRING	用于标识和重用的友好名称
secret_id	STRING	包含身份验证凭据的 secret 的 ID
secret_name	STRING	用于显示的 secret 名称
provider	STRING	LLM 提供商（例如，“openai”、“anthropic”、“cohere”、“bedrock”）
model_name	STRING	提供商特定的模型标识符（例如，“gpt-4o”、“claude-3-5-sonnet”）
created_at	INT64	模型定义创建时的时间戳（自纪元以来的毫秒数）
last_updated_at	INT64	模型定义最后更新时的时间戳（自纪元以来的毫秒数）
created_by	STRING	创建模型定义的用户 ID
last_updated_by	STRING	最后更新模型定义的用户 ID

GatewaySecretInfo

Secret 元数据实体（不包含解密的 secret 值）

字段名称	类型	描述
secret_id	STRING	Secret 的唯一标识符（UUID）
secret_name	STRING	Secret 的友好名称（必须唯一）
masked_values	一个 MaskedValuesEntry 数组	Secret 值的掩码版本，用于显示为键值对。对于简单的 API 密钥：{“api_key”: “sk-…xyz123”} 对于复合凭据：{"aws_access_key_id": "AKI...1234", "aws_secret_access_key": "***"}
created_at	INT64	Secret 创建时的时间戳（自纪元以来的毫秒数）
last_updated_at	INT64	Secret 最后更新时的时间戳（自纪元以来的毫秒数）
provider	STRING	LLM 提供商标识符（例如，“openai”、“anthropic”、“cohere”）
created_by	STRING	创建 secret 的用户 ID
last_updated_by	STRING	最后更新 secret 的用户 ID
auth_config_json	STRING	提供商特定的身份验证配置（JSON，例如区域、项目 ID）

InputTag

输入的标签。

字段名称	类型	描述
key	STRING	标签键。此字段是必需的。
value	STRING	标签值。此字段是必需的。

MaskedValuesEntry

字段名称	类型	描述
key	STRING
value	STRING

Metric

与运行关联的指标，表示为键值对。

字段名称	类型	描述
key	STRING	标识此指标的键。
value	DOUBLE	与此指标关联的值。
timestamp	INT64	记录此指标的时间戳。
step	INT64	记录指标的步骤。

ModelInput

表示 Run 的 LoggedModel 或 Registered Model Version 输入。

字段名称	类型	描述
model_id	STRING	模型的唯一标识符。此字段是必需的。

ModelMetric

与模型关联的指标，表示为键值对。从 MLflow 指标复制

字段名称	类型	描述
key	STRING	标识此指标的键。
value	DOUBLE	与此指标关联的值。
timestamp	INT64	记录此指标的时间戳。
step	INT64	记录指标的步骤。

ModelOutput

表示一个运行的 LoggedModel 输出。

字段名称	类型	描述
model_id	STRING	模型的唯一标识符。此字段是必需的。
step	INT64	模型生成的步数。此字段是必需的。

ModelParam

模型版本的参数。

字段名称	类型	描述
name	STRING	参数的名称。
value	STRING	与名称关联的参数值，可能为空

ModelVersion

字段名称	类型	描述
name	STRING	模型的唯一名称。
version	STRING	模型的版本号。
creation_timestamp	INT64	创建此 model_version 时记录的时间戳。
last_updated_timestamp	INT64	最后更新此 model_version 元数据时记录的时间戳。
user_id	STRING	创建此 model_version 的用户。
current_stage	STRING	此 model_version 的当前阶段。
description	STRING	此 model_version 的描述。
source	STRING	指示源模型构件位置的 URI，在创建 model_version 时使用
run_id	STRING	创建 model_version 时使用的 MLflow 运行 ID，如果 source 是由存储在 MLflow 跟踪服务器中的实验运行生成的。
status	ModelVersionStatus	此 model_version 的当前状态。
status_message	STRING	当前 status 的详细信息，如果它正在等待或失败。
tags	一个 ModelVersionTag 数组	Tags: 此 model_version 的附加元数据键值对。
run_link	STRING	Run Link: 指向生成此版本的运行的直接链接。此字段仅在模型版本创建时为源运行来自与注册表服务器不同的跟踪服务器的模型版本设置。
aliases	一个 STRING 数组	指向此 model_version 的别名。
model_id	STRING	模型版本的 model_id（可选），用于将已注册模型链接到源记录模型
model_params	一系列 ModelParam	模型的可选参数。
model_metrics	一系列 ModelMetric	模型的可选指标。
deployment_job_state	ModelVersionDeploymentJobState	此模型版本的部署作业状态。

ModelVersionDeploymentJobState

字段名称	类型	描述
job_id	STRING
run_id	STRING
job_state	State
run_state	DeploymentJobRunState
current_task_name	STRING

ModelVersionTag

模型版本的标签。

字段名称	类型	描述
key	STRING	标签键。
value	STRING	标签值。

Param

与运行关联的参数。

字段名称	类型	描述
key	STRING	标识此参数的键。
value	STRING	与此参数关联的值。

RegisteredModel

字段名称	类型	描述
name	STRING	模型的唯一名称。
creation_timestamp	INT64	创建此 registered_model 时记录的时间戳。
last_updated_timestamp	INT64	最后更新此 registered_model 元数据时记录的时间戳。
user_id	STRING	创建此 registered_model 的用户 NOTE：此字段当前未返回。
description	STRING	此 registered_model 的描述。
latest_versions	一个 ModelVersion 数组	每个阶段的最新模型版本集合。仅包含当前 READY 状态的模型。
tags	一个 RegisteredModelTag 数组	Tags: 此 registered_model 的附加元数据键值对。
aliases	一系列 RegisteredModelAlias	指向与此 registered_model 关联的模型版本的别名。
deployment_job_id	STRING	此模型的部署作业 ID。
deployment_job_state	State	此模型的部署作业状态。

RegisteredModelAlias

注册模型的别名。

字段名称	类型	描述
alias	STRING	别名的名称。
version	STRING	别名指向的模型版本号。

RegisteredModelTag

注册模型的标签。

字段名称	类型	描述
key	STRING	标签键。
value	STRING	标签值。

Run

单个运行。

字段名称	类型	描述
info	RunInfo	运行元数据。
data	RunData	运行数据。
inputs	RunInputs	运行输入。
输出	RunOutputs	运行输出。

RunData

运行数据（指标、参数和标签）。

字段名称	类型	描述
metrics	一个 Metric 数组	运行指标。
params	一个 Param 数组	运行参数。
tags	一个 RunTag 数组	附加元数据键值对。

RunInfo

单个运行的元数据。

字段名称	类型	描述
run_id	STRING	运行的唯一标识符。
run_uuid	STRING	[已弃用，请使用 run_id] 运行的唯一标识符。此字段将在未来的 MLflow 版本中删除。
run_name	STRING	运行的名称。
experiment_id	STRING	实验 ID。
user_id	STRING	发起运行的用户。此字段自 MLflow 1.0 起已弃用，将在未来的 MLflow 版本中删除。请改用“mlflow.user”标签。
status	RunStatus	运行的当前状态。
start_time	INT64	运行开始时间的 Unix 时间戳（以毫秒为单位）。
end_time	INT64	运行结束时间的 Unix 时间戳（以毫秒为单位）。
artifact_uri	STRING	应上传构件的目录的 URI。这可以是本地路径（以“/”开头），也可以是分布式文件系统 (DFS) 路径，例如 s3://bucket/directory 或 dbfs:/my/directory。如果未设置，将选择本地 ./mlruns 目录。
lifecycle_stage	STRING	实验的当前生命周期阶段：OneOf(“active”, “deleted”)

RunInputs

运行输入。

字段名称	类型	描述
dataset_inputs	一个 DatasetInput 数组	运行的数据集输入。
model_inputs	一系列 ModelInput	运行的模型输入。

RunOutputs

运行的输出。

字段名称	类型	描述
model_outputs	一系列 ModelOutput	运行的模型输出。

RunTag

运行的标签。

字段名称	类型	描述
key	STRING	标签键。
value	STRING	标签值。

Scorer

Scorer 实体，表示数据库中的一个评分器。

字段名称	类型	描述
experiment_id	INT32	实验 ID。
scorer_name	STRING	评分器的名称。
scorer_version	INT32	评分器的版本。
serialized_scorer	STRING	序列化的评分器字符串。
creation_time	INT64	评分器版本的创建时间（自纪元以来以毫秒为单位）。
scorer_id	STRING	评分器的唯一标识符。

SecretValueEntry

字段名称	类型	描述
key	STRING
value	STRING

SecretValueEntry

字段名称	类型	描述
key	STRING
value	STRING

DeploymentJobRunState

Name	描述
DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED
NO_VALID_DEPLOYMENT_JOB_FOUND
RUNNING
SUCCEEDED
FAILED
PENDING
APPROVAL

ModelVersionStatus

Name	描述
PENDING_REGISTRATION	注册新模型版本的请求正在等待，因为服务器正在执行后台任务。
FAILED_REGISTRATION	注册新模型版本的请求已失败。
READY	模型版本已准备好使用。

RunStatus

运行的状态。

Name	描述
RUNNING	运行已启动。
SCHEDULED	运行计划稍后运行。
FINISHED	运行已完成。
FAILED	运行执行失败。
KILLED	运行被用户杀死。

State

Name	描述
DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED
NOT_SET_UP	默认状态
CONNECTED	已连接的作业：作业存在，所有者具有 ACL，并且存在必需的作业参数。
NOT_FOUND	作业已删除或所有者已删除作业 ACL。
REQUIRED_PARAMETERS_CHANGED	必需的作业参数已更改。

ViewType

ListExperiments 查询的视图类型。

Name	描述
ACTIVE_ONLY	默认。仅返回活动实验。
DELETED_ONLY	仅返回已删除的实验。
ALL	获取所有实验。