REST API

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

重要提示

MLflow REST API 要求所有 POST 请求的内容类型为 `application/json`。

---

创建实验

端点	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	视图类型	要返回的实验类型的限定符。如果未指定，仅返回活动实验。

响应结构

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

---

获取实验

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

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

请求结构

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

响应结构

字段名称	类型	描述
experiment	实验	实验详情。

---

通过名称获取实验

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

获取实验的元数据。

此端点将返回已删除的实验，但如果活动实验和已删除实验具有相同的名称，则优先返回活动实验。如果多个已删除实验具有相同的名称，API 将返回其中一个。

如果不存在指定名称的实验，抛出 `RESOURCE_DOES_NOT_EXIST` 异常。

请求结构

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

响应结构

字段名称	类型	描述
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/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/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	运行	新创建的运行。

---

更新运行

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

更新运行元数据。

请求结构

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

响应结构

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

---

删除运行

端点	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	运行	运行元数据（名称、开始时间等）和数据（指标、参数和标签）。

---

搜索运行

端点	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	视图类型	显示仅活动的、仅已删除的还是所有运行。默认为仅活动运行。
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 处理，如果开始时间相同，则由 run_id 处理（如果未提供 order_by，这也是默认的排序标准）。
page_token	STRING

响应结构

字段名称	类型	描述
runs	Run 的数组	符合搜索条件的运行。
next_page_token	STRING

---

记录指标

端点	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	记录指标时的步数
model_id	STRING	如果适用，与指标关联的记录模型 ID
dataset_name	STRING	与指标关联的数据集名称。例如“my.uc.table@2”、“nyc-taxi-dataset”、“fantastic-elk-3”
dataset_digest	STRING	与指标关联的数据集的摘要，例如数据集的 md5 哈希值，用于在同名数据集中唯一标识它。

---

记录参数

端点	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/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	JSON 格式的 MLmodel 文件。

---

记录输入

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

请求结构

字段名称	类型	描述
run_id	STRING	要记录的运行 ID。此字段为必需。
datasets	DatasetInput 的数组	数据集输入
models	ModelInput 的数组	模型输入（目前未记录在 LoggedModels 私有预览版中）

---

设置标签

端点	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/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/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 方法
3.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 方法
3.0/mlflow/scorers/list	GET

列出实验的所有评分器。

请求结构

列出所有评分器，可选地限定在一个实验内。

字段名称	类型	描述
experiment_id	STRING	实验 ID。如果为空，则返回活动工作区中所有实验的评分器（由管理员 UI 评分器选择器使用）。

响应结构

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

---

列出评分器版本

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

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

请求结构

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

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

响应结构

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

---

获取评分器

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

获取实验的特定评分器。

请求结构

获取实验的特定评分器。

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

响应结构

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

---

删除评分器

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

删除实验的评分器。

请求结构

删除实验的评分器。

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

---

创建网关密钥

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

为 LLM 提供程序认证创建一个新的加密密钥

请求结构

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

响应结构

字段名称	类型	描述
secret	网关密钥信息	创建的密钥元数据（不包含加密值）

---

获取网关密钥信息

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

获取关于密钥的元数据（不包含加密值）

请求结构

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

响应结构

字段名称	类型	描述
secret	网关密钥信息	密钥元数据（不包含加密值）

---

更新网关密钥

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

更新现有密钥的值或认证配置

请求结构

字段名称	类型	描述
secret_id	STRING	要更新的密钥 ID
secret_value	SecretValueEntry 的数组	用于密钥轮换的可选新密钥值（作为键值对，空映射 = 无更改）。对于简单 API 密钥：{“api_key”: “sk-xxx”} 对于复合凭证：{“aws_access_key_id”: “…”, “aws_secret_access_key”: “…”}
auth_config	AuthConfigEntry 的数组	可选的新认证配置。对于多认证提供程序，包含“auth_mode”键（例如 {“auth_mode”: “access_keys”, “aws_region_name”: “us-east-1”}）
updated_by	STRING	更新者的用户名

响应结构

字段名称	类型	描述
secret	网关密钥信息	更新后的密钥元数据

---

删除网关密钥

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

删除密钥

请求结构

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

---

列出网关密钥

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

按提供程序进行可选过滤，列出所有密钥

请求结构

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

响应结构

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

---

创建网关模型定义

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

创建可重用的模型定义

请求结构

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

响应结构

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

---

获取网关模型定义

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

按 ID 获取模型定义

请求结构

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

响应结构

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

---

列出网关模型定义

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

列出带有可选过滤器的所有模型定义

请求结构

字段名称	类型	描述
provider	STRING	按提供程序过滤（可选）
secret_id	STRING	按密钥 ID 过滤（可选）

响应结构

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

---

更新网关模型定义

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

更新模型定义

请求结构

字段名称	类型	描述
model_definition_id	STRING	要更新的模型定义 ID
name	STRING	可选的新名称
secret_id	STRING	可选的新密钥 ID
model_name	STRING	可选的新模型名称
updated_by	STRING	更新者的用户名
provider	STRING	可选的新提供程序

响应结构

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

---

删除网关模型定义

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

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

请求结构

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

---

创建网关端点

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

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

请求结构

字段名称	类型	描述
name	STRING	端点的可选用户友好名称
model_configs	GatewayEndpointModelConfig 的数组	模型配置列表
created_by	STRING	创建者的用户名
routing_strategy	路由策略	端点的可选路由策略
fallback_config	回退配置	可选的回退配置（包括策略、最大尝试次数）
experiment_id	STRING	用于追踪的可选实验 ID。仅在 usage_tracking 为 true 时使用。如果未提供且 usage_tracking 为 true，则会自动创建实验。
usage_tracking	BOOL	是否为此端点启用使用追踪。默认为 false。为 true 时，将记录端点调用的追踪。

响应结构

字段名称	类型	描述
endpoint	网关端点	具有所有模型映射的创建端点

---

获取网关端点

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

获取包含所有模型配置的端点详情

请求结构

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

响应结构

字段名称	类型	描述
endpoint	网关端点	具有所有模型配置的端点

---

更新网关端点

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

更新端点名称

请求结构

字段名称	类型	描述
endpoint_id	STRING	要更新的端点 ID
name	STRING	端点的可选新名称
updated_by	STRING	更新者的用户名
model_configs	GatewayEndpointModelConfig 的数组	模型配置的可选新列表（替换所有现有的模型链接）
routing_strategy	路由策略	端点的可选新路由策略
fallback_config	回退配置	可选的回退配置（包括策略、最大尝试次数）
experiment_id	STRING	用于追踪的可选实验 ID。仅在 usage_tracking 为 true 时使用。
usage_tracking	BOOL	是否为此端点启用使用追踪。设为 true 时，将记录端点调用的追踪。设为 false 时，禁用使用追踪并清除 experiment_id。

响应结构

字段名称	类型	描述
endpoint	网关端点	更新后的端点

---

删除网关端点

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

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

请求结构

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

---

列出网关端点

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

按提供程序或密钥进行可选过滤，列出端点

请求结构

字段名称	类型	描述
provider	STRING	按提供程序过滤（可选）
secret_id	STRING	按密钥 ID 过滤（可选）

响应结构

字段名称	类型	描述
endpoints	GatewayEndpoint 的数组	带有模型配置的端点列表

---

将模型附加到端点

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

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

请求结构

字段名称	类型	描述
endpoint_id	STRING	要将模型附加到的端点 ID
model_config	网关端点模型配置	要附加的模型配置
created_by	STRING	创建者的用户名

响应结构

字段名称	类型	描述
mapping	网关端点模型映射	创建的映射

---

从端点分离模型

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

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

请求结构

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

---

创建端点绑定

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

在端点和 MLflow 资源之间创建绑定

请求结构

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

响应结构

字段名称	类型	描述
binding	网关端点绑定	创建的绑定

---

删除端点绑定

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

删除端点和资源之间的绑定

请求结构

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

---

列出端点绑定

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

列出端点的所有绑定

请求结构

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

响应结构

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

---

设置网关端点标签

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

在端点上设置标签

请求结构

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

---

删除网关端点标签

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

从端点删除标签

请求结构

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

---

创建提示优化任务

端点	HTTP 方法
3.0/mlflow/prompt-optimization/jobs	POST

创建新的提示优化任务。此端点使用指定的配置启动优化运行。优化过程异步运行，可以通过 getPromptOptimizationJob 进行监控。

请求结构

字段名称	类型	描述
experiment_id	STRING	用于跟踪优化任务的 MLflow 实验 ID。
source_prompt_uri	STRING	要优化的源提示 URI（例如“prompts:/my-prompt/1”）。
config	提示优化任务配置	优化任务的配置。
tags	PromptOptimizationJobTag 的数组	优化任务的可选标签。

响应结构

字段名称	类型	描述
job	提示优化任务	创建的优化任务。

---

获取提示优化任务

端点	HTTP 方法
3.0/mlflow/prompt-optimization/jobs/{job_id}	GET

获取提示优化任务的详情和状态。返回任务配置、当前状态、进度统计，如果优化已完成，则返回最佳提示。

请求结构

字段名称	类型	描述
job_id	STRING	优化任务的唯一标识符（与 run_id 相同）。

响应结构

字段名称	类型	描述
job	提示优化任务	优化任务详情。

---

搜索提示优化任务

端点	HTTP 方法
3.0/mlflow/prompt-optimization/jobs/search	POST

搜索提示优化任务。返回匹配指定过滤器的优化任务列表。

请求结构

字段名称	类型	描述
experiment_id	STRING	要搜索优化任务的 MLflow 实验 ID。

响应结构

字段名称	类型	描述
jobs	PromptOptimizationJob 的数组	优化任务列表。

---

取消提示优化任务

端点	HTTP 方法
3.0/mlflow/prompt-optimization/jobs/{job_id}/cancel	POST

取消正在进行的提示优化任务。如果任务已完成或已取消，此操作无效。

请求结构

字段名称	类型	描述
job_id	STRING	要取消的优化任务的唯一标识符。

响应结构

字段名称	类型	描述
job	提示优化任务	已取消的优化任务。

---

删除提示优化任务

端点	HTTP 方法
3.0/mlflow/prompt-optimization/jobs/{job_id}	DELETE

删除提示优化任务及其关联数据。这将永久移除任务及所有相关信息。

请求结构

字段名称	类型	描述
job_id	STRING	要删除的优化任务的唯一标识符。

---

创建预签名上传 URL

端点	HTTP 方法
2.0/mlflow/artifacts/presigned-upload-url	POST

生成一个预签名 URL，用于将制品直接上传到云存储。服务器使用其自己的凭证对 URL 进行签名，使客户端无需直接的云存储写入权限即可上传制品。

由外部制品存储库插件使用（例如 https://github.com/aws/sagemaker-mlflow）。

请求结构

字段名称	类型	描述
run_id	STRING	拥有该制品的运行 ID。必须提供。
path	STRING	运行制品目录内的相对路径（例如“models/model.pkl”）。必须提供。
expiration	INT64	URL 过期时间（秒，默认：900）。

响应结构

字段名称	类型	描述
presigned_url	STRING	用于直接制品上传的预签名 URL。
headers	HeadersEntry 的数组	上传请求所需的请求头（例如 Content-Type）。

---

创建预算策略

端点	HTTP 方法
3.0/mlflow/gateway/budgets/create	POST

创建新的预算策略

请求结构

字段名称	类型	描述
budget_unit	预算单位
budget_amount	DOUBLE
duration	预算时长
target_scope	预算目标范围
budget_action	预算操作
created_by	STRING

响应结构

字段名称	类型	描述
budget_policy	网关预算策略

---

获取预算策略

端点	HTTP 方法
3.0/mlflow/gateway/budgets/get	GET

通过 ID 获取预算策略

请求结构

字段名称	类型	描述
budget_policy_id	STRING

响应结构

字段名称	类型	描述
budget_policy	网关预算策略

---

更新预算策略

端点	HTTP 方法
3.0/mlflow/gateway/budgets/update	POST

更新预算策略

请求结构

字段名称	类型	描述
budget_policy_id	STRING
budget_unit	预算单位
budget_amount	DOUBLE
duration	预算时长
target_scope	预算目标范围
budget_action	预算操作
updated_by	STRING

响应结构

字段名称	类型	描述
budget_policy	网关预算策略

---

删除预算策略

端点	HTTP 方法
3.0/mlflow/gateway/budgets/delete	DELETE

删除预算策略

请求结构

字段名称	类型	描述
budget_policy_id	STRING

---

列出预算策略

端点	HTTP 方法
3.0/mlflow/gateway/budgets/list	GET

列出预算策略

请求结构

字段名称	类型	描述
max_results	INT64
page_token	STRING

响应结构

字段名称	类型	描述
budget_policies	GatewayBudgetPolicy 数组
next_page_token	STRING

---

列出预算窗口

端点	HTTP 方法
3.0/mlflow/gateway/budgets/windows	GET

列出预算窗口及其当前支出

响应结构

字段名称	类型	描述
windows	BudgetWindow 数组

---

创建护栏

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/create	POST

创建一个由评分器支持的新护栏

请求结构

字段名称	类型	描述
name	STRING
scorer_id	STRING
scorer_version	INT64
stage	护栏阶段
action	护栏操作
action_endpoint_id	STRING	该操作所使用的 LLM 的可选网关端点 ID。

响应结构

字段名称	类型	描述
guardrail	网关护栏

---

获取护栏

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/get	GET

通过 ID 获取护栏

请求结构

字段名称	类型	描述
guardrail_id	STRING

响应结构

字段名称	类型	描述
guardrail	网关护栏

---

删除护栏

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/delete	DELETE

删除护栏

请求结构

字段名称	类型	描述
guardrail_id	STRING

---

列出护栏

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/list	GET

列出护栏

请求结构

字段名称	类型	描述
max_results	INT64
page_token	STRING

响应结构

字段名称	类型	描述
guardrails	GatewayGuardrail 数组
next_page_token	STRING

---

将护栏添加到端点

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/add-to-endpoint	POST

将护栏添加到网关端点

请求结构

字段名称	类型	描述
endpoint_id	STRING
guardrail_id	STRING
execution_order	INT64

响应结构

字段名称	类型	描述
config	网关护栏配置

---

从端点移除护栏

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/remove-from-endpoint	DELETE

从网关端点移除护栏

请求结构

字段名称	类型	描述
endpoint_id	STRING
guardrail_id	STRING

---

列出端点护栏配置

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/list-for-endpoint	GET

列出端点的护栏配置

请求结构

字段名称	类型	描述
endpoint_id	STRING

响应结构

字段名称	类型	描述
configs	GatewayGuardrailConfig 数组

---

更新端点护栏配置

端点	HTTP 方法
3.0/mlflow/gateway/guardrails/update-config	PATCH

请求结构

字段名称	类型	描述
endpoint_id	STRING	端点 ID。
guardrail_id	STRING	护栏 ID。
execution_order	INT64	新的执行顺序。

响应结构

字段名称	类型	描述
config	网关护栏配置

---

创建已注册模型 (RegisteredModel)

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

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

请求结构

字段名称	类型	描述
name	STRING	以此名称注册模型。此字段为必填项。
tags	RegisteredModelTag 数组	已注册模型的附加元数据。
description	STRING	已注册模型的可选描述。
deployment_job_id	STRING	该模型的部署作业 ID。

响应结构

字段名称	类型	描述
registered_model	注册模型

---

获取已注册模型

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

请求结构

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

响应结构

字段名称	类型	描述
registered_model	注册模型

---

重命名已注册模型

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

请求结构

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

响应结构

字段名称	类型	描述
registered_model	注册模型

---

更新已注册模型

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

请求结构

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

响应结构

字段名称	类型	描述
registered_model	注册模型

---

删除已注册模型

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

请求结构

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

---

搜索已注册模型

端点	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	分页令牌，用于请求下一页模型。

---

获取最新模型版本

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

请求结构

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

响应结构

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

---

创建模型版本 (ModelVersion)

端点	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	模型版本	返回为此注册表中的模型生成的新版本号。

---

获取模型版本

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

请求结构

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

响应结构

字段名称	类型	描述
model_version	模型版本

---

更新模型版本

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

请求结构

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

响应结构

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

---

删除模型版本

端点	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	期望返回的最大模型数量。最大阈值为 20 万。后端可以选择更小的默认值和最大阈值。
order_by	STRING 的数组	用于排序的列列表，包括模型名称、版本、阶段，带有可选的“DESC”或“ASC”注解（默认为“ASC”）。平局按最后阶段转换时间戳排序，其次是名称 ASC，最后是版本 DESC。
page_token	STRING	分页令牌，用于根据之前的搜索查询跳转到下一页。

响应结构

字段名称	类型	描述
model_versions	ModelVersion 数组	符合搜索条件的模型
next_page_token	STRING	分页令牌，用于为相同的搜索查询请求下一页模型。

---

获取模型版本工件的下载 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	模型版本	更新后的模型版本

---

设置已注册模型标签

端点	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	POST

请求结构

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

---

删除已注册模型别名

端点	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	模型版本

---

创建 Webhook

端点	HTTP 方法
2.0/mlflow/webhooks	POST

请求结构

创建 Webhook 请求

字段名称	类型	描述
name	STRING	Webhook 名称。此字段为必填项。
description	STRING	Webhook 的可选描述
url	STRING	发送 Webhook 事件的 URL。此字段为必填项。
events	WebhookEvent 数组	要订阅的事件列表。此字段为必填项。
secret	STRING	HMAC 签名验证的密钥
status	Webhook 状态	初始状态（若未指定，默认为 ACTIVE）

响应结构

字段名称	类型	描述
webhook	Webhook

---

列出 Webhooks

端点	HTTP 方法
2.0/mlflow/webhooks	GET

请求结构

列出 Webhooks 请求

字段名称	类型	描述
max_results	INT32	要返回的最大 Webhook 数量
page_token	STRING	来自先前请求的分页令牌

响应结构

字段名称	类型	描述
webhooks	Webhook 数组	Webhooks 列表
next_page_token	STRING	用于下一页的分页令牌

---

获取 Webhook

端点	HTTP 方法
2.0/mlflow/webhooks/{webhook_id}	GET

请求结构

获取 Webhook 请求

字段名称	类型	描述
webhook_id	STRING	要检索的 Webhook ID。此字段为必填项。

响应结构

字段名称	类型	描述
webhook	Webhook

---

更新 Webhook

端点	HTTP 方法
2.0/mlflow/webhooks/{webhook_id}	PATCH

请求结构

更新 Webhook 请求

字段名称	类型	描述
webhook_id	STRING	要更新的 Webhook ID。此字段为必填项。
name	STRING	Webhook 的新名称
description	STRING	Webhook 的新描述
url	STRING	Webhook 的新 URL
events	WebhookEvent 数组	要订阅的新事件列表
secret	STRING	用于 HMAC 签名的新密钥
status	Webhook 状态	Webhook 的新状态

响应结构

字段名称	类型	描述
webhook	Webhook

---

删除 Webhook

端点	HTTP 方法
2.0/mlflow/webhooks/{webhook_id}	DELETE

请求结构

删除 Webhook 请求

字段名称	类型	描述
webhook_id	STRING	要删除的 Webhook ID。此字段为必填项。

---

测试 Webhook

端点	HTTP 方法
2.0/mlflow/webhooks/{webhook_id}/test	POST

请求结构

测试 Webhook 请求

字段名称	类型	描述
webhook_id	STRING	要测试的 Webhook ID。此字段为必填项。
event	Webhook 事件	可选的事件类型进行测试。如果未指定，默认为 Webhook 订阅事件中的第一个事件类型。

响应结构

字段名称	类型	描述
result	Webhook 测试结果

---

下载工件

端点	HTTP 方法
2.0/mlflow-artifacts/artifacts/<path:artifact_path>	GET

---

上传工件

端点	HTTP 方法
2.0/mlflow-artifacts/artifacts/<path:artifact_path>	PUT

---

列出工件

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

请求结构

字段名称	类型	描述
path	STRING	过滤匹配此路径的制品（从根制品目录开始的相对路径）。

响应结构

字段名称	类型	描述
files	FileInfo 数组	制品的路径和元数据。

---

删除工件

端点	HTTP 方法
2.0/mlflow-artifacts/artifacts/<path:artifact_path>	DELETE

---

创建工件分段上传

端点	HTTP 方法
2.0/mlflow-artifacts/mpu/create/<path:artifact_path>	POST

请求结构

字段名称	类型	描述
path	STRING
num_parts	INT64

响应结构

字段名称	类型	描述
upload_id	STRING
credentials	MultipartUploadCredential 数组

---

完成工件分段上传

端点	HTTP 方法
2.0/mlflow-artifacts/mpu/complete/<path:artifact_path>	POST

请求结构

字段名称	类型	描述
path	STRING
upload_id	STRING
parts	MultipartUploadPart 数组

---

中止工件分段上传

端点	HTTP 方法
2.0/mlflow-artifacts/mpu/abort/<path:artifact_path>	POST

请求结构

字段名称	类型	描述
path	STRING
upload_id	STRING

---

获取分段下载的预签名 URL

端点	HTTP 方法
2.0/mlflow-artifacts/presigned/<path:artifact_path>	GET

响应结构

字段名称	类型	描述
url	STRING	用于直接从云存储下载工件的预签名 URL。
headers	HeadersEntry 数组	下载请求中必须包含的可选标头。
file_size	INT64	可选的文件大小（字节）。

数据结构

AddDatasetToExperiments

字段名称	类型	描述
dataset_id	STRING	要添加到实验的数据集 ID。此字段为必填项。
experiment_ids	STRING 的数组	与数据集关联的实验 ID

Assessment

轨迹评估的数据和元数据。

字段名称	类型	描述
assessment_id	STRING	评估的唯一 ID。注意：这不是通过“validate_required”标记为必填的字段，因为该消息是在创建新评估的上下文中使用，此时 ID 未知。
assessment_name	STRING	评估名称。名称不得包含“.”。此字段为必填项。
trace_id	STRING	此评估关联的轨迹 ID。
span_id	STRING	如果评估是针对特定范围 (span) 的，则为该范围的 ID（可选）。
source	AssessmentSource（评估来源）	此评估的来源。
create_time	google.protobuf.Timestamp	此评估的创建时间。
last_update_time	google.protobuf.Timestamp	此评估的最后更新时间。
rationale（理由）	STRING	评估的理由。
metadata	MetadataEntry 数组	描述评估并存储额外信息的附加元数据，例如块相关性 chunk_index。此元数据必须是 JSON 可序列化的。
overrides	STRING	此评估所覆盖的评估 ID。
valid	BOOL	此评估是否有效（即尚未被取代）。默认为 true，若创建了新的替代评估，则设为 false。
feedback 或 expectation 或 issue	Feedback 或 Expectation 或 IssueReference	如果是 feedback，则为来自此评估的轨迹反馈。如果是 expectation，则为代理指南和/或预期响应的表示。如果是 issue，则为与此轨迹关联的问题参考。

AssessmentError

字段名称	类型	描述
error_code	STRING	发生错误时评估的值。
error_message	STRING
stack_trace	STRING	错误的堆栈跟踪。截断为 1000 个字符，以避免 TraceInfo 过大。

AssessmentSource

字段名称	类型	描述
source_type	来源类型	源类型。此字段为必填项。
source_id	STRING	源标识符。例如：人工 -> 用户名；LLM 判断 -> 判断来源（Databricks 或自定义）；代码 -> 为空。此字段为必填项。

AuthConfigEntry

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

AuthConfigEntry

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

AuthConfigEntry

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

BatchGetTraceInfos

字段名称	类型	描述
trace_ids	STRING 的数组	要获取的轨迹 ID。必须提供。

BatchGetTraces

字段名称	类型	描述
trace_ids	STRING 的数组	要获取的轨迹 ID。必须提供。

BudgetDuration

固定窗口持续时间：定义预算窗口时长的 (unit, value) 对

字段名称	类型	描述
unit	预算时长单位	时间单位 (MINUTES, HOURS, DAYS, WEEKS, MONTHS)
value	INT32	每个窗口的单位数

BudgetWindow

字段名称	类型	描述
budget_policy_id	STRING
window_start_ms	INT64
window_end_ms	INT64
current_spend	DOUBLE

CalculateTraceFilterCorrelation

字段名称	类型	描述
experiment_ids	STRING 的数组	要搜索的实验 ID 列表。
filter_string1	STRING	第一个过滤条件（例如，“span.type = ‘LLM’”）。
filter_string2	STRING	第二个过滤条件（例如，“feedback.quality > 0.8”）。
base_filter	STRING	可选的基础过滤器，filter1 和 filter2 都在其之上进行测试（例如，时间窗口使用 ‘request_time > … and request_time < …’）。

CreateAssessment

字段名称	类型	描述
assessment	评估 (Assessment)	要创建的评估。此字段为必填项。

CreateDataset

字段名称	类型	描述
name	STRING	数据集名称。此字段为必填项。
experiment_ids	STRING 的数组	关联的实验 ID。若未提供，默认为当前活动的实验。
source_type	来源类型	源类型
source	STRING	源信息
schema	STRING	模式信息 (JSON)
profile	STRING	概况信息 (JSON)
created_by	STRING	创建数据集的用户
tags	STRING	在数据集上设置的标签（键值对的 JSON 字符串）

CreateLoggedModel

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段为必需。
name	STRING	模型名称。可选。若未指定，后端将生成一个。
model_type	STRING	模型类型，例如 “Agent”、“Classifier”、“LLM”。
source_run_id	STRING	创建此模型的运行的 ID。
params	LoggedModelParameter 数组	已记录模型的参数。
tags	LoggedModelTag 数组	已记录模型的标签。

CreateWorkspace

创建一个新的工作空间。

字段名称	类型	描述
name	STRING	要创建的工作区名称。此字段为必填项。
description	STRING	可选的工作区描述。
default_artifact_root	STRING	可选的默认工件根覆盖，在创建时应用。
trace_archival_config	追踪归档配置	可选的轨迹归档设置，在创建时应用。

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	数据集的源信息。注意，如果数据集在使用前经过转换/修改，源可能无法精确重现该数据集。此字段为必填项。
schema	STRING	数据集的模式。例如，DataFrame 的 MLflow ColSpec JSON、ndarray 的 MLflow TensorSpec JSON 或其他模式格式。
profile	STRING	数据集概况。数据集的汇总统计信息，例如表中的行数、表中每一列的平均值/标准差/众数或数组中的元素数。

Dataset

字段名称	类型	描述
dataset_name	STRING	数据集名称。此字段为必填项。
dataset_digest	STRING	数据集的摘要。

Dataset

字段名称	类型	描述
dataset_id	STRING	数据集的唯一标识符
name	STRING	数据集名称（用户友好标识符）
tags	STRING	作为 JSON 字符串的标签（元数据的键值对）
schema	STRING	模式信息 (JSON)
profile	STRING	概况信息 (JSON)
digest	STRING	用于完整性检查的数据集摘要
created_time	INT64	创建时间戳（毫秒）
last_update_time	INT64	最后更新时间戳（毫秒）
created_by	STRING	创建数据集的用户
last_updated_by	STRING	最后更新数据集的用户
experiment_ids	STRING 的数组	关联的实验 ID（从 entity_associations 表填充）

DatasetInput

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

字段名称	类型	描述
tags	InputTag 数组	数据集输入的标签列表，例如值设为 “training” 的 “context” 标签
dataset	数据集	作为运行输入使用的数据集。此字段为必填项。

DatasetRecord

字段名称	类型	描述
dataset_record_id	STRING	记录的唯一标识符
dataset_id	STRING	此记录所属的数据集 ID
inputs	STRING	作为 JSON 字符串的输入
期望值 (expectations)	STRING	作为 JSON 字符串的预期
tags	STRING	作为 JSON 字符串的标签
source	STRING	作为 JSON 字符串的源信息
source_id	STRING	用于快速查找的源 ID（例如 trace_id）
source_type	来源类型	源类型
created_time	INT64	创建时间戳（毫秒）
last_update_time	INT64	最后更新时间戳（毫秒）
created_by	STRING	创建该记录的用户
last_updated_by	STRING	最后更新该记录的用户
输出	STRING	作为 JSON 字符串的输出

DatasetRecordSource

字段名称	类型	描述
source_type	来源类型	源类型。
source_data	STRING	作为 JSON 的特定于源的数据

DatasetSummary

DatasetSummary。表示有关数据集信息的摘要。

字段名称	类型	描述
experiment_id	STRING	实验的唯一标识符。此字段为必填项。
name	STRING	数据集名称。例如 “my.uc.table@2”、“nyc-taxi-dataset”、“fantastic-elk-3”。此字段为必填项。
digest	STRING	数据集摘要，例如数据集的 md5 哈希值，在同名数据集中唯一标识它。此字段为必填项。
context（上下文）	STRING	如果为给定数据集设置，则为 “context” 标签的值。

DeleteAssessment

根据 trace_id 和 assessment_id 删除评估的请求。删除成功时响应为空。

字段名称	类型	描述
trace_id	STRING	轨迹 ID。此字段为必填项。
assessment_id	STRING	评估 ID。此字段为必填项。

DeleteDataset

字段名称	类型	描述
dataset_id	STRING	要删除的数据集 ID。此字段为必填项。

DeleteDatasetRecords

字段名称	类型	描述
dataset_id	STRING	要删除记录的数据集 ID。此字段为必填项。
dataset_record_ids	STRING 的数组	要删除的数据集记录 ID 列表。

DeleteDatasetTag

字段名称	类型	描述
dataset_id	STRING	要从中删除标签的数据集 ID。此字段为必填项。
key	STRING	要删除的标签键。此字段为必填项。

DeleteLoggedModel

字段名称	类型	描述
model_id	STRING	要删除的 LoggedModel ID。此字段为必填项。

DeleteLoggedModelTag

字段名称	类型	描述
model_id	STRING	要从中删除标签的 LoggedModel ID。此字段为必填项。
tag_key	STRING	标签键。此字段为必填项。

DeleteTraceTag

字段名称	类型	描述
request_id	STRING	要删除标签的轨迹 ID。
key	STRING	要删除的标签名称。

DeleteTraceTagV3

字段名称	类型	描述
trace_id	STRING	要删除标签的轨迹 ID。
key	STRING	要删除的标签名称。

DeleteTraces

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段为必需。
max_timestamp_millis	INT64	情况 1：基于时间的删除必须指定 max_timestamp_millis 和 max_traces。自 UNIX 纪元以来删除轨迹的最大毫秒时间戳。
max_traces	INT32	要删除的最大轨迹数。
request_ids	STRING 的数组	情况 2：基于 ID 的删除必须指定 request_ids。要删除的一组请求 ID

DeleteTracesV3

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。此字段为必需。
max_timestamp_millis	INT64	情况 1：基于时间的删除必须指定 max_timestamp_millis 和 max_traces。自 UNIX 纪元以来删除轨迹的最大毫秒时间戳。
max_traces	INT32	要删除的最大轨迹数。
request_ids	STRING 的数组	情况 2：基于 ID 的删除必须指定 request_ids。要删除的一组请求 ID

DeleteWorkspace

删除工作区。

字段名称	类型	描述
workspace_name	STRING	要删除的工作区名称。此字段为必填项。

DimensionsEntry

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

EndTrace

字段名称	类型	描述
request_id	STRING	要结束的轨迹 ID。
timestamp_ms	INT64	轨迹结束时的 UNIX 时间戳（毫秒）。
status	追踪状态	正在追踪操作的总体状态（OK、error 等）。
request_metadata	TraceRequestMetadata 数组	关于正在追踪的操作的附加元数据。
tags	TraceTag 数组	要添加到轨迹的附加标签。

Expectation

对模型或代理从轨迹包含的输入中应产生的输出值或指南的期望。

字段名称	类型	描述
value	google.protobuf.Value	基于期望评估的值。其底层使用 google.protobuf.Value 来支持灵活的期望值模式，但经过验证以将其限制为特定类型。这意味着值必须是符合以下支持类型之一的 JSON：* 数字值，如整数或浮点数 * 布尔值 * 文本值（可包含用户希望存储的 JSON 文本，但仅能作为文本搜索） * 仅包含字符串的列表值（允许空列表）。其他值如 null、结构体、非字符串列表等将被拒绝。不过，它们可以序列化为字符串并存储在 serialized_value 字段中。serialized_value 或 value 只能定义其中之一。尽管使用 google.protobuf.Value，由于序列化和反序列化的安全风险，我们不支持这些其他格式。
serialized_value	序列化值	以指定格式序列化为字符串的基于期望的评估值。serialized_value 或 value 只能定义其中之一。

Experiment

实验

字段名称	类型	描述
experiment_id	STRING	实验的唯一标识符。
name	STRING	用于标识实验的可读名称。
artifact_location	STRING	存储实验工件的位置。
lifecycle_stage	STRING	实验的当前生命周期阶段：“active”或“deleted”。已删除的实验不会由 API 返回。
last_update_time	INT64	最后更新时间
creation_time	INT64	创建时间
tags	ExperimentTag 的数组	标签：附加的元数据键值对。
effective_trace_archival_retention	STRING	应用更广泛范围和实验覆盖后的有效轨迹归档保留期。
workspace	STRING	实验的工作区名称（若未启用工作区，则始终为 default）。

ExperimentTag

实验标签。

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

FallbackConfig

故障转移路由配置

字段名称	类型	描述
strategy	回退策略	故障转移策略。
max_attempts	INT32	故障转移路由的最大尝试次数（不能超过目标数量）。

Feedback

对轨迹中包含的模型/代理输出提供的反馈

字段名称	类型	描述
value	google.protobuf.Value	基于反馈的评估值。我们使用 google.protobuf.Value 来支持灵活的反馈值模式。支持的初始类型：- 数字值，如整数或浮点数 - 布尔值 - 文本值（可包含用户希望存储的 JSON 文本，但仅能作为文本搜索） - 仅包含字符串的非空列表值 - 目前拒绝其他值，如结构体、非字符串列表等
error	评估错误	生成反馈时遇到的错误。若值为 null，则必须提供。

FileInfo

单个工件文件或目录的元数据。

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

FileInfo

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

FinalEvalScoresEntry

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

FinalizeLoggedModel

字段名称	类型	描述
model_id	STRING	要最终确定的 LoggedModel ID。此字段为必填项。
status	记录模型状态	模型是否准备好使用。此消息中的有效值：ENUM<LOGGED_MODEL_READY, LOGGED_MODEL_UPLOAD_FAILED>（“LOGGED_MODEL_UPLOAD_FAILED”表示在记录模型权重/代理代码时出错）。此字段为必填项。

GatewayBudgetPolicy

表示 AI 网关的预算策略

字段名称	类型	描述
budget_policy_id	STRING	此预算策略的唯一标识符
budget_unit	预算单位	预算计量单位（例如 USD）
budget_amount	DOUBLE	预算限额金额
duration	预算时长	固定时间窗口（单位+长度对）
target_scope	预算目标范围	预算范围（GLOBAL 或 WORKSPACE）
budget_action	预算操作	超出预算时的操作
created_by	STRING	创建策略的用户 ID
created_at	INT64	创建时间戳（毫秒）
last_updated_by	STRING	最后更新策略的用户 ID
last_updated_at	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 数组	与端点关联的标签
routing_strategy	路由策略	端点的路由策略
fallback_config	回退配置	故障转移配置（如果 routing_strategy 为 FALLBACK 则填充）
experiment_id	STRING	记录此端点轨迹的 MLflow 实验 ID
usage_tracking	BOOL	是否为此端点启用使用情况跟踪。为 true 时，如果未提供实验，将自动创建，并记录端点调用的轨迹。

GatewayEndpointBinding

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

字段名称	类型	描述
endpoint_id	STRING	此绑定引用的端点 ID
resource_type	STRING	MLflow 资源类型（例如，“scorer”）
resource_id	STRING	特定资源实例的 ID
created_at	INT64	绑定创建时间戳（纪元毫秒）
last_updated_at	INT64	绑定最后更新时间戳（纪元毫秒）
created_by	STRING	创建绑定的用户 ID
last_updated_by	STRING	最后更新绑定的用户 ID
display_name	STRING	保留字段 8-9 - 已移除 endpoint_name 和 model_mappings（客户端连接）资源的易读显示名称（例如，评分器名称）

GatewayEndpointModelConfig

附加到端点的模型配置

字段名称	类型	描述
model_definition_id	STRING	模型定义的 ID
linkage_type	网关模型链接类型	链接类型
weight	FLOAT	流量分配的路由权重
fallback_order	INT32	故障转移尝试顺序（仅适用于 FALLBACK 链接，PRIMARY 为 NULL）

GatewayEndpointModelMapping

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

字段名称	类型	描述
mapping_id	STRING	此映射的唯一标识符
endpoint_id	STRING	端点 ID
model_definition_id	STRING	模型定义的 ID
model_definition	网关模型定义	完整的模型定义（通过 JOIN 填充）
weight	FLOAT	流量分配的路由权重
created_at	INT64	映射创建时间戳（纪元毫秒）
created_by	STRING	创建映射的用户 ID
linkage_type	网关模型链接类型	链接类型
fallback_order	INT32	故障转移尝试顺序（仅适用于 FALLBACK 链接，PRIMARY 为 NULL）

GatewayEndpointTag

与端点关联的标签

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

GatewayGuardrail

字段名称	类型	描述
guardrail_id	STRING
name	STRING
scorer	评分器
stage	护栏阶段
action	护栏操作
action_endpoint_id	STRING	该操作所使用的 LLM 的可选网关端点 ID（例如消毒）。
created_by	STRING
created_at	INT64
last_updated_by	STRING
last_updated_at	INT64

GatewayGuardrailConfig

字段名称	类型	描述
endpoint_id	STRING
guardrail_id	STRING
execution_order	INT64
created_by	STRING
created_at	INT64
guardrail	网关护栏	完整的护栏实体，列出配置时填充。

GatewayModelDefinition

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

字段名称	类型	描述
model_definition_id	STRING	此模型定义的唯一标识符
name	STRING	用于标识和重用的用户友好名称
secret_id	STRING	包含认证凭证的密钥 ID
secret_name	STRING	用于显示目的的密钥名称
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_id	STRING	密钥的唯一标识符 (UUID)
secret_name	STRING	密钥的用户友好名称（必须唯一）
masked_values	MaskedValuesEntry 数组	用于显示为键值对的密钥掩码版本。简单 API 密钥：{“api_key”: “sk-…xyz123”} 复合凭据：{"aws_access_key_id": "AKI...1234", "aws_secret_access_key": "***"}
created_at	INT64	密钥创建时间戳（纪元毫秒）
last_updated_at	INT64	密钥最后更新时间戳（纪元毫秒）
provider	STRING	LLM 提供商标识符（例如 “openai”、“anthropic”、“cohere”）
created_by	STRING	创建密钥的用户 ID
last_updated_by	STRING	最后更新密钥的用户 ID
auth_config	AuthConfigEntry 数组	提供程序特定的身份验证配置（例如 auth_mode, region, project_id）

GetAssessmentRequest

字段名称	类型	描述
trace_id	STRING	该评估所属的轨迹 ID。此字段为必填项。
assessment_id	STRING	评估 ID。此字段为必填项。

GetDataset

字段名称	类型	描述
dataset_id	STRING	数据集 ID。此字段为必填项。
page_token	STRING	记录分页的可选页面令牌

GetDatasetExperimentIds

字段名称	类型	描述
dataset_id	STRING	要获取实验 ID 的数据集 ID。此字段为必填项。

GetDatasetRecords

字段名称	类型	描述
dataset_id	STRING	要获取记录的数据集 ID。此字段为必填项。
max_results	INT32	可选分页 - 要返回的最大记录数
page_token	STRING	用于获取下一页的可选分页令牌

GetLoggedModel

字段名称	类型	描述
model_id	STRING	要检索的 LoggedModel ID。此字段为必填项。

GetMetricHistoryBulkInterval

字段名称	类型	描述
run_ids	STRING 的数组	要获取指标值的运行 ID。必须提供。
metric_key	STRING	指标名称。此字段为必需。
start_step	INT32	可选的起始步，仅获取指定步之后的指标。如果定义了 end_step，则必须定义此项。
end_step	INT32	可选的结束步，仅获取指定步之前的指标。如果定义了 start_step，则必须定义此项。
max_results	INT32	每个运行获取的最大结果数。必须设置为正数。注意，实际上该 API 最多返回 (max_results + # of run IDs) x (# run IDs) 个指标数据点。

GetOnlineTraceDetails

字段名称	类型	描述
trace_id	STRING	要检索的轨迹 ID。此字段为必填项。
sql_warehouse_id	STRING	查询使用的 SQL 仓库。此字段为必填项。
source_inference_table	STRING	查询使用的源推理表，例如 “ml.bbqiu.codegen_payload”。此字段为必填项。
source_databricks_request_id	STRING	查询使用的源 Databricks 请求 ID，例如 “8d1992ce-ba3d-49e9-9701-e9b323c5cc8c”。此字段为必填项。

GetTrace

字段名称	类型	描述
trace_id	STRING	要获取的轨迹 ID。必须提供。此字段为必填项。
allow_partial	BOOL	是否允许部分轨迹。默认为 False。

GetTraceInfo

字段名称	类型	描述
request_id	STRING	要获取的轨迹 ID。必须提供。

GetTraceInfoV3

字段名称	类型	描述
trace_id	STRING	要获取的轨迹 ID。必须提供。

GetWorkspace

检索工作区元数据。

字段名称	类型	描述
workspace_name	STRING	要获取的工作区名称。此字段为必填项。

HeadersEntry

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

HeadersEntry

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

HeadersEntry

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

InferenceTableLocation

字段名称	类型	描述
full_table_name	STRING	完整的推理表名称，格式为 catalog.schema.table_name

InitialEvalScoresEntry

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

InputTag

输入标签。

字段名称	类型	描述
key	STRING	标签键。此字段为必填项。
value	STRING	标签值。此字段为必填项。

IssueReference

与此轨迹关联的问题参考

字段名称	类型	描述
issue_name	STRING	此评估引用的问题名称。此字段为必填项。

JobState

将状态与元数据相结合的通用作业状态消息。提供了一种跨不同作业类型表示作业状态的统一方式。

字段名称	类型	描述
status	任务状态	作业的当前状态。
error_message	STRING	如果作业失败，则显示错误消息。仅在状态为 JOB_STATUS_FAILED 时设置。
metadata	MetadataEntry 数组	作为键值对的附加元数据。可用于存储作业特定的状态信息。

LinkPromptsToTrace

字段名称	类型	描述
trace_id	STRING	要链接提示版本的轨迹 ID。此字段为必填项。
prompt_versions	PromptVersionRef 数组

LinkTracesToRun

字段名称	类型	描述
trace_ids	STRING 的数组	要链接到运行的轨迹 ID。单次请求中最多可链接 100 个轨迹 ID。
run_id	STRING	要链接轨迹的运行 ID。此字段为必填项。

ListLoggedModelArtifacts

字段名称	类型	描述
model_id	STRING	要列出工件的 LoggedModel ID。此字段为必填项。
artifact_directory_path	STRING	过滤匹配此路径的制品（从根制品目录开始的相对路径）。
page_token	STRING	指示要获取的制品结果页面的令牌

LogLoggedModelParamsRequest

字段名称	类型	描述
model_id	STRING	要记录参数的 LoggedModel ID。此字段为必填项。
params	LoggedModelParameter 数组	附加到模型的参数。

LogOutputs

字段名称	类型	描述
run_id	STRING	要从中记录输出的运行 ID。此字段为必填项。
models	ModelOutput 数组	来自运行的模型输出。

LoggedModel

LoggedModel 消息包括已记录的模型属性、标签、注册信息、参数和链接的运行指标。

字段名称	类型	描述
info	记录模型信息	已记录模型的属性，如模型 ID、状态、标签等。
data	记录模型数据	已记录模型的参数和指标。

LoggedModelData

LoggedModelData 消息包括已记录的模型参数和链接的指标。

字段名称	类型	描述
params	LoggedModelParameter 数组	模型的不可变字符串键值对。
metrics	Metric 的数组	链接到模型的性能指标。

LoggedModelInfo

LoggedModelInfo 包括已记录的模型属性、标签和注册信息。

字段名称	类型	描述
model_id	STRING	模型的唯一标识符。
experiment_id	STRING	拥有该模型的实验 ID。
name	STRING	模型名称。
creation_timestamp_ms	INT64	模型创建时间戳（自 UNIX 纪元以来的毫秒）。
last_updated_timestamp_ms	INT64	模型最后更新时间戳（自 UNIX 纪元以来的毫秒）
artifact_uri	STRING	存储模型工件的目录 URI。
status	记录模型状态	模型是否准备好使用。
creator_id	INT64	创建该模型用户或主体的 ID。
model_type	STRING	模型类型，例如 “Agent”、“Classifier”、“LLM”。
source_run_id	STRING	创建该模型的运行的运行 ID。
status_message	STRING	当前状态的详细信息。
tags	LoggedModelTag 数组	在模型上设置的可变字符串键值对。
registrations	LoggedModelRegistrationInfo 的数组	如果模型已提升至模型注册表（Model Registry），该字段将包含注册模型名称、模型版本号等信息。

LoggedModelParameter

与 LoggedModel 关联的参数。

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

LoggedModelRegistrationInfo

LoggedModel 的注册信息。

字段名称	类型	描述
name	STRING	模型被提升至的注册模型名称。
version	STRING	被提升模型的版本号。

LoggedModelTag

LoggedModel 的标签。

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

MaskedValuesEntry

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

MetadataEntry

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

MetadataEntry

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

Metric

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

字段名称	类型	描述
key	STRING	用于标识此指标的键。
value	DOUBLE	与此指标关联的值。
timestamp	INT64	记录此指标的时间戳。
step	INT64	记录指标的步数。
dataset_name	STRING	与指标关联的数据集名称。例如“my.uc.table@2”、“nyc-taxi-dataset”、“fantastic-elk-3”
dataset_digest	STRING	与指标关联的数据集的摘要，例如数据集的 md5 哈希值，用于在同名数据集中唯一标识它。
model_id	STRING	与该指标关联的 LoggedModel 或注册模型版本的 ID（如果适用）。
run_id	STRING	包含该指标的运行 ID。

MetricAggregation

字段名称	类型	描述
aggregation_type	聚合类型	要执行的聚合类型。
percentile_value	DOUBLE	要计算的百分位数（0-100），在 aggregation_type 为 PERCENTILE 时必需。示例：50（中位数）、75、90、95、99。该字段在其他聚合类型中将被忽略。

MetricDataPoint

包含维度值和指标值的单个数据点。

字段名称	类型	描述
metric_name	STRING	指标名称，例如“latency”。
dimensions	DimensionsEntry 的数组	此数据点的维度值。键对应维度，例如 {“status”: “OK”}。
values	ValuesEntry 的数组	此数据点的指标值。键为聚合类型，例如 {“AVG”: 150, “P99”: 234.5}。

MetricWithRunId

字段名称	类型	描述
key	STRING	用于标识此指标的键。
value	DOUBLE	与此指标关联的值。
timestamp	INT64	记录此指标的时间戳。
step	INT64	记录指标的步数。
run_id	STRING	包含该指标的运行 ID。

MlflowExperimentLocation

字段名称	类型	描述
experiment_id	STRING	MLflow 实验 ID，是保存追踪（trace）的 ACL 容器。

ModelInput

代表运行（Run）输入的 LoggedModel 或注册模型版本。

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

ModelMetric

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

字段名称	类型	描述
key	STRING	用于标识此指标的键。
value	DOUBLE	与此指标关联的值。
timestamp	INT64	记录此指标的时间戳。
step	INT64	记录指标的步数。
dataset_name	STRING	与指标关联的数据集名称。例如“my.uc.table@2”、“nyc-taxi-dataset”、“fantastic-elk-3”
dataset_digest	STRING	与指标关联的数据集的摘要，例如数据集的 md5 哈希值，用于在同名数据集中唯一标识它。
model_id	STRING	与该指标关联的 LoggedModel 或注册模型版本的 ID。
run_id	STRING	包含该指标的运行 ID。

ModelOutput

代表运行（Run）输出的 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	模型版本状态	model_version 的当前状态。
status_message	STRING	当前 status 的详细信息（如果处于待处理或失败状态）。
tags	ModelVersionTag 数组	标签：此 model_version 的附加元数据键值对。
run_link	STRING	运行链接：指向生成此版本的运行的直接链接。该字段仅在模型版本创建时为那些源运行来自与注册服务器不同的跟踪服务器的模型版本设置。
aliases	STRING 的数组	指向此 model_version 的别名。
model_id	STRING	用于将已注册模型链接到已记录源模型的模型版本可选 model_id
model_params	ModelParam 的数组	模型的可选参数。
model_metrics	ModelMetric 的数组	模型的可选指标。
deployment_job_state	模型版本部署任务状态	此模型版本的部署作业状态。

ModelVersionDeploymentJobState

字段名称	类型	描述
job_id	STRING
run_id	STRING
job_state	状态
run_state	部署任务运行状态
current_task_name	STRING

ModelVersionTag

模型版本的标签。

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

MultipartUploadCredential

字段名称	类型	描述
url	STRING
part_number	INT64
headers	HeadersEntry 的数组

MultipartUploadPart

字段名称	类型	描述
part_number	INT64
etag	STRING
url	STRING

OrderBy

字段名称	类型	描述
field_name	STRING	排序依据的字段名称，例如“metrics.accuracy”。此字段为必填项。
ascending	BOOL	排序是否为升序。
dataset_name	STRING	如果 field_name 指向指标，则此字段指定与该指标关联的数据集名称。只有与指定数据集名称关联的指标才会被考虑用于排序。此字段仅在 field_name 指向指标时才能设置。
dataset_digest	STRING	如果 field_name 指向指标，则此字段指定与该指标关联的数据集摘要（digest）。只有与指定数据集名称和摘要关联的指标才会被考虑用于排序。此字段仅在设置了 dataset_name 时才能设置。

Param

与运行关联的参数。

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

PromptOptimizationJob

代表提示词优化作业实体。

字段名称	类型	描述
job_id	STRING	优化作业的唯一标识符。用于轮询作业执行状态（待处理/运行中/已完成/失败）。
run_id	STRING	存储优化指标和结果的 MLflow 运行 ID。使用此 ID 在 MLflow UI 中查看结果。仅在作业开始运行后可用。
state	任务状态	作业的当前状态（状态 + 错误信息 + 元数据）。
experiment_id	STRING	跟踪此优化作业的 MLflow 实验 ID。
source_prompt_uri	STRING	优化开始的源提示词 URI（例如，“prompts:/my-prompt/1”）。
optimized_prompt_uri	STRING	优化后的提示词 URI（例如，“prompts:/my-prompt/2”）。仅在优化成功完成后设置。
config	提示优化任务配置	优化任务的配置。
creation_timestamp_ms	INT64	作业创建的时间戳（自纪元以来的毫秒数）。
completion_timestamp_ms	INT64	作业完成的时间戳（自纪元以来的毫秒数）。仅在状态为 COMPLETED、FAILED 或 CANCELED 时设置。
tags	PromptOptimizationJobTag 的数组	与此作业关联的标签。
initial_eval_scores	InitialEvalScoresEntry 的数组	优化前的初始评估分数，按评估器名称键入。示例：{“Correctness”: 0.65, “Safety”: 0.80}
final_eval_scores	FinalEvalScoresEntry 的数组	优化后的最终评估分数，按评估器名称键入。示例：{“Correctness”: 0.89, “Safety”: 0.95}

PromptOptimizationJobConfig

提示词优化作业的配置。作为运行参数存储在底层 MLflow 运行中。

字段名称	类型	描述
optimizer_type	优化器类型	要使用的优化器类型。
dataset_id	STRING	包含训练数据的 EvaluationDataset ID。
scorers	STRING 的数组	评估器名称列表。可以是内置评估器类名（例如，“Correctness”、“Safety”）或注册的评估器名称。
optimizer_config_json	STRING	JSON 序列化的特定于优化器的配置。不同的优化器接受不同的参数：- GEPA: {“reflection_model”: “openai:/gpt-5”, “max_metric_calls”: 300} - MetaPrompt: {“reflection_model”: “openai:/gpt-5”, “guidelines”: “…”, “lm_kwargs”: {…}}

PromptOptimizationJobTag

提示词优化作业的标签。

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

PromptVersionRef

用于链接到追踪的提示词版本引用。每个引用都包含提示词名称和版本。

字段名称	类型	描述
name	STRING	此字段为必填项。
version	STRING	此字段为必填项。

QueryTraceMetrics

查询追踪、跨度（span）或评估的聚合指标。

字段名称	类型	描述
experiment_ids	STRING 的数组	必填：用于搜索追踪的实验 ID。
view_type	指标视图类型	必填：聚合指标的级别。
metric_name	STRING	必填：要查询的指标名称（例如“latency”）。
aggregations	MetricAggregation 的数组	必填：要应用的聚合方式。
dimensions	STRING 的数组	可选：按维度对指标进行分组（例如，“name”，“status”）。
filters	STRING 的数组	可选：要应用的筛选表达式（例如 trace.status=”OK”）。
time_interval_seconds	INT64	可选：分组的时间间隔（秒）。设置后，结果将自动包含按指定间隔分组的时间维度。示例：60（分）、3600（时）、86400（天）、604800（周）、2592000（月）。
start_time_ms	INT64	可选：时间范围的起始点（自纪元以来的毫秒数）。如果设置了 time_interval_seconds，则为必填项。
end_time_ms	INT64	可选：时间范围的结束点（自纪元以来的毫秒数）。如果设置了 time_interval_seconds，则为必填项。
max_results	INT32	可选：返回的最大数据点数。默认值：1000。
page_token	STRING	可选：用于获取下一页结果的分页令牌。

RegisteredModel

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

RegisteredModelAlias

注册模型的别名。

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

RegisteredModelTag

注册模型的标签。

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

RemoveDatasetFromExperiments

字段名称	类型	描述
dataset_id	STRING	要从实验中删除的数据集 ID。此字段为必填项。
experiment_ids	STRING 的数组	要解除与数据集关联的实验 ID。

Response

字段名称	类型	描述
metrics	MetricWithRunId 的数组	表示值和元数据历史记录的指标列表。

Response

字段名称	类型	描述
assessment	评估 (Assessment)	创建的评估。

Response

字段名称	类型	描述
assessment	评估 (Assessment)	更新后的评估。

Response

字段名称	类型	描述
assessment	评估 (Assessment)	请求的评估。

Response

字段名称	类型	描述
trace_info	追踪信息	新创建的追踪。

Response

字段名称	类型	描述
trace_info	追踪信息	更新后的追踪。

Response

字段名称	类型	描述
trace_info	追踪信息	请求追踪的元数据。

Response

字段名称	类型	描述
trace	追踪

Response

字段名称	类型	描述
traces	Trace 的数组	获取的追踪信息。

Response

字段名称	类型	描述
trace_infos	TraceInfoV3 的数组	获取的追踪元数据。

Response

字段名称	类型	描述
trace	追踪	包含跨度（span）的获取追踪。

Response

字段名称	类型	描述
traces	TraceInfo 的数组	有关匹配搜索条件的追踪信息。
next_page_token	STRING

Response

字段名称	类型	描述
traces	TraceInfo 的数组	有关匹配搜索条件的追踪信息。
next_page_token	STRING

Response

字段名称	类型	描述
trace_data	STRING	以字符串形式返回追踪 JSON。注意：未来可能会将其更改为 TraceData 对象。

Response

字段名称	类型	描述
traces_deleted	INT32

Response

字段名称	类型	描述
traces_deleted	INT32

Response

字段名称	类型	描述
npmi	DOUBLE	归一化逐点互信息分数（-1 到 1）。
npmi_smoothed	DOUBLE	使用 Jeffreys 先验进行稳健性平滑后的 NPMI 值。
filter1_count	INT32	匹配第一个筛选器的追踪数量。
filter2_count	INT32	匹配第二个筛选器的追踪数量。
joint_count	INT32	同时匹配两个筛选器的追踪数量。
total_count	INT32	实验中的追踪总数。

Response

字段名称	类型	描述
data_points	MetricDataPoint 的数组	按维度分组的数据点。
next_page_token	STRING	用于获取下一页的分页令牌。如果没有更多结果，则为空。

Response

字段名称	类型	描述
trace	追踪	创建的追踪信息。

Response

字段名称	类型	描述
dataset_summaries	DatasetSummary 的数组	返回最近创建的 N 个数据集的摘要（后端配置）。

Response

字段名称	类型	描述
model	记录模型	新创建的 LoggedModel。

Response

字段名称	类型	描述
model	记录模型	更新后的 LoggedModel。

Response

字段名称	类型	描述
model	记录模型	检索到的 LoggedModel。

Response

字段名称	类型	描述
models	LoggedModel 的数组	匹配搜索条件的已记录模型。
next_page_token	STRING	可用于检索下一页已记录模型的令牌。

Response

字段名称	类型	描述
model	记录模型	更新后的 LoggedModel。

Response

字段名称	类型	描述
root_uri	STRING	已记录模型的根制品目录。
files	FileInfo 的数组	制品的路径和元数据。
next_page_token	STRING	可用于检索下一页制品结果的令牌

Response

字段名称	类型	描述
traces	TraceInfoV3 的数组	有关匹配搜索条件的追踪信息。
next_page_token	STRING

Response

字段名称	类型	描述
dataset	数据集	创建的数据集。

Response

字段名称	类型	描述
dataset	数据集	数据集（不包含记录，采用延迟加载）。
next_page_token	STRING	如果有更多记录存在，则为下一页令牌。

Response

字段名称	类型	描述
datasets	Dataset 的数组	数据集列表（仅包含元数据）。
next_page_token	STRING	如果有更多结果存在，则为下一页令牌。

Response

字段名称	类型	描述
dataset	数据集	更新后的数据集。

Response

字段名称	类型	描述
inserted_count	INT32	插入记录的数量。
updated_count	INT32	更新记录的数量。

Response

字段名称	类型	描述
experiment_ids	STRING 的数组	与数据集关联的实验 ID 列表。

Response

字段名称	类型	描述
records	STRING	数据集中的记录（JSON 序列化列表）。
next_page_token	STRING	用于下一页的分页令牌（如果有更多记录）。

Response

字段名称	类型	描述
deleted_count	INT32	删除记录的数量。

Response

字段名称	类型	描述
dataset	数据集	具有新实验关联的更新后数据集。

Response

字段名称	类型	描述
dataset	数据集	删除实验关联后的更新数据集。

Response

字段名称	类型	描述
secrets_available	BOOL	服务器是否配置为处理密钥（支持加密）。

Response

字段名称	类型	描述
workspaces	Workspace 的数组	工作空间记录集合。

Response

字段名称	类型	描述
workspace	工作区	描述创建的工作空间的元数据。

Response

字段名称	类型	描述
workspace	工作区	描述请求的工作空间的元数据。

Response

字段名称	类型	描述
workspace	工作区	描述更新的工作空间的元数据。

Run

单个运行。

字段名称	类型	描述
info	运行信息	运行元数据。
data	运行数据	运行数据。
inputs	运行输入	运行输入。
输出	运行输出	运行输出。

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	运行状态	运行的当前状态。
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

表示数据库中评分器的评分器实体。

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

SearchDatasets

字段名称	类型	描述
experiment_ids	STRING 的数组	要搜索的实验 ID 列表。

SearchEvaluationDatasets

字段名称	类型	描述
experiment_ids	STRING 的数组	关联的实验 ID（用于筛选）。
filter_string	STRING	数据集名称的筛选字符串。
max_results	INT32	最大结果数。
order_by	STRING 的数组	排序标准。
page_token	STRING	用于分页的页面令牌。

SearchLoggedModels

字段名称	类型	描述
experiment_ids	STRING 的数组	要搜索已记录模型的实验 ID。
filter	STRING	对已记录模型信息和数据执行筛选的表达式，允许返回已记录模型的子集。语法是支持将二进制操作进行 AND 运算的 SQL 子集。示例：params.alpha < 0.3 AND metrics.accuracy > 0.9。
datasets	Dataset 的数组	要应用指标筛选子句的数据集列表。例如，具有 metrics.accuracy > 0.9 的筛选器以及名为 “test_dataset” 的数据集信息，意味着我们将返回在 test_dataset 上准确度 > 0.9 的所有已记录模型。将考虑匹配条件的任何数据集中的指标值。如果没有指定数据集，则筛选器会考虑所有数据集的指标。
max_results	INT32	要返回的已记录模型最大数量。最大阈值为 50。
order_by	OrderBy 的数组	用于对结果进行排序的列列表，以及用于排序标准的附加字段。
page_token	STRING	指示要获取的已记录模型页面的令牌。

SearchTraces

字段名称	类型	描述
experiment_ids	STRING 的数组	要搜索的实验 ID 列表。
filter	STRING	对追踪属性和标签执行筛选的表达式，允许返回追踪的子集。语法是支持将二进制操作进行 AND 运算的 SQL 子集。示例：trace.status = 'OK' and trace.timestamp_ms > 1711089570679。
max_results	INT32	所需的最大追踪数。最大阈值为 500。
order_by	STRING 的数组	用于对结果进行排序的列列表，例如 ["timestamp_ms DESC"]。
page_token	STRING	指示要获取的追踪页面的令牌。

SearchTracesV3

字段名称	类型	描述
locations	TraceLocation 的数组	要搜索的 MLflow 实验列表。
filter	STRING	对追踪属性和标签执行筛选的表达式，允许返回追踪的子集。语法是支持将二进制操作进行 AND 运算的 SQL 子集。示例：trace.status = 'OK' and trace.timestamp_ms > 1711089570679。
max_results	INT32	所需的最大追踪数。最大阈值为 500。
order_by	STRING 的数组	用于对结果进行排序的列列表，例如 ["timestamp_ms DESC"]。
page_token	STRING	指示要获取的追踪页面的令牌。

SearchUnifiedTraces

字段名称	类型	描述
model_id	STRING	此字段为必填项。
sql_warehouse_id	STRING	此字段为必填项。
experiment_ids	STRING 的数组	待办事项：最终我们希望提供一个仅使用 model_id 的 API。
filter	STRING	对追踪属性和标签执行筛选的表达式，允许返回追踪的子集。语法是支持将二进制操作进行 AND 运算的 SQL 子集。示例：trace.status = 'OK' and trace.timestamp_ms > 1711089570679。
max_results	INT32	所需的最大追踪数。最大阈值为 500。
order_by	STRING 的数组	用于对结果进行排序的列列表，例如 ["timestamp_ms DESC"]。
page_token	STRING	指示要获取的追踪页面的令牌。这是一个统一的令牌，编码了在线和离线追踪令牌。

SecretValueEntry

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

SecretValueEntry

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

SerializedValue

字段名称	类型	描述
serialization_format	STRING	标记期望值的序列化格式。这是客户端特定的契约。服务不会尝试反序列化该值或验证格式。示例格式为 “JSON_FORMAT”。
value	STRING	以 serialization_format 定义的格式序列化为字符串的基于期望的评估值。

SetDatasetTags

字段名称	类型	描述
dataset_id	STRING	要更新标签的数据集 ID。此字段为必填项。
tags	STRING	要更新的标签（JSON 字符串）。此字段为必填项。

SetLoggedModelTags

字段名称	类型	描述
model_id	STRING	要设置标签的 LoggedModel ID。此字段为必填项。
tags	LoggedModelTag 数组	标签键。

SetTraceTag

字段名称	类型	描述
request_id	STRING	要设置标签的追踪 ID。
key	STRING	标签名称。最大大小取决于存储后端。所有存储后端均保证支持最大 250 字节的键值。
value	STRING	要记录的标签的字符串值。最大大小取决于存储后端。所有存储后端均保证支持最大 250 字节的键值。

SetTraceTagV3

字段名称	类型	描述
trace_id	STRING	要设置标签的追踪 ID。
key	STRING	标签名称。最大大小取决于存储后端。所有存储后端均保证支持最大 250 字节的键值。
value	STRING	要记录的标签的字符串值。最大大小取决于存储后端。所有存储后端均保证支持最大 250 字节的键值。

StartTrace

字段名称	类型	描述
experiment_id	STRING	关联实验的 ID。
timestamp_ms	INT64	追踪开始的 Unix 时间戳（毫秒）。
request_metadata	TraceRequestMetadata 数组	关于发起追踪的请求的元数据。
tags	TraceTag 数组	追踪的标签。

StartTraceV3

字段名称	类型	描述
trace	追踪	要创建的追踪信息。此字段为必填项。

TagsEntry

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

Trace

字段名称	类型	描述
trace_info	追踪信息 V3
spans	opentelemetry.proto.trace.v1.Span 的数组

TraceArchivalConfig

工作空间 API 接受并在工作空间元数据中返回的追踪存档设置。

字段名称	类型	描述
location	STRING	可选的存档存储库根路径覆盖。
retention	STRING	可选的存档保留期限覆盖。格式：<int><unit>，例如 30d。

TraceInfo

TraceInfo。代表追踪的元数据。

字段名称	类型	描述
request_id	STRING	追踪的唯一标识符。
experiment_id	STRING	包含该追踪的实验 ID。
timestamp_ms	INT64	追踪开始的 Unix 时间戳（毫秒）。
execution_time_ms	INT64	追踪持续时间的 Unix 时间戳（毫秒）。
status	追踪状态	正在追踪的操作的整体状态（OK、错误等）。
request_metadata	TraceRequestMetadata 数组	其他追踪元数据。
tags	TraceTag 数组	追踪的标签。

TraceInfoV3

字段名称	类型	描述
trace_id	STRING	与追踪关联的主键。
client_request_id	STRING	客户端提供的与追踪关联的请求 ID。这可用于从产生追踪的外部系统识别追踪/请求。
trace_location	TraceLocation
request	STRING	[已弃用，请改用 request_preview。] 对模型/代理的请求。等同于根跨度的输入，但为了易于访问而添加。表示为 JSON 字符串。
response	STRING	[已弃用，请改用 request_preview。] 模型/代理的响应。等同于根跨度的输出，但为了易于访问而添加。表示为 JSON 字符串。
request_preview	STRING	表示为 JSON 字符串的模型/代理请求预览。这等同于根跨度的输入。此预览值被截断为 10KB，而完整请求存储在 Blob 存储的追踪数据中。
response_preview	STRING	表示为 JSON 字符串的模型/代理请求预览。这等同于根跨度的输出。此预览值被截断为 10KB，而完整响应存储在 Blob 存储的追踪数据中。
request_time	google.protobuf.Timestamp	追踪的开始时间。
execution_duration	google.protobuf.Duration	追踪执行时间。
state	状态
trace_metadata	TraceMetadataEntry 的数组	与追踪关联的元数据。示例包括：- run_id: 产生追踪的 mlflow 运行（即评估作业）的 ID。在某些情况下（如通过交互式验证创建追踪）可能不适用 - model_id: 产生追踪的关联模型 ID - dataset_id: mlflow 数据集的 ID（通常与 dataset_record_id 一起使用） - dataset_record_id: mlflow 数据集的 ID（通常与 dataset_record_id 一起使用） - session_id: 请求来源的会话 ID（例如聊天对话）
assessments	Assessment 的数组
tags	TagsEntry 的数组	可变的、用户定义的追踪标签，例如 “question_topic”: “DBSQL”

TraceLocation

存储和产生追踪的位置。

字段名称	类型	描述
type	追踪位置类型
mlflow_experiment 或 inference_table	MlflowExperimentLocation 或 InferenceTableLocation	如果是 mlflow_experiment，如果是 inference_table，

TraceMetadataEntry

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

TraceRequestMetadata

字段名称	类型	描述
key	STRING	用于标识此元数据的键。
value	STRING	用于标识此元数据的值。

TraceTag

字段名称	类型	描述
key	STRING	用于标识此追踪标签的键。
value	STRING	与此追踪标签关联的值。

UpdateAssessment

更新现有评估的请求。

字段名称	类型	描述
assessment	评估 (Assessment)	包含应更新字段的评估。此字段为必填项。
update_mask	google.protobuf.FieldMask	要更新的评估字段列表。这些应对应于 assessment 中存在的值（或缺失情况）。此字段为必填项。

UpdateWorkspace

更新工作空间元数据。

字段名称	类型	描述
workspace_name	STRING	要更新的工作空间名称。此字段为必填项。
description	STRING	可选的描述更新。
default_artifact_root	STRING	可选的默认制品根路径覆盖更新。
trace_archival_config	追踪归档配置	可选的追踪存档设置更新。

UpsertDatasetRecords

字段名称	类型	描述
dataset_id	STRING	要更新记录的数据集 ID。此字段为必填项。
records	STRING	要更新的记录（记录字典的 JSON 序列化列表）。此字段为必填项。
updated_by	STRING	执行更新的用户。

ValuesEntry

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

Webhook

Webhook 实体。

字段名称	类型	描述
webhook_id	STRING	Webhook 的唯一标识符。
name	STRING	Webhook 名称。
description	STRING	Webhook 的可选描述
url	STRING	发送 Webhook 事件的 URL。
events	WebhookEvent 数组	此 Webhook 订阅的事件列表。
status	Webhook 状态	Webhook 的当前状态。
creation_timestamp	INT64	Webhook 创建的时间戳。
last_updated_timestamp	INT64	Webhook 最后更新的时间戳。

WebhookEvent

Webhook 事件定义。

字段名称	类型	描述
entity	Webhook 实体	实体类型（必填项）。此字段为必填项。
action	Webhook 操作	操作类型（必填项）。此字段为必填项。

WebhookTestResult

测试 Webhook 结果。

字段名称	类型	描述
success	BOOL	测试是否成功。
response_status	INT32	HTTP 响应状态码（如果可用）。
response_body	STRING	响应体（如果可用）。
error_message	STRING	如果测试失败，则显示错误信息。

Workspace

工作空间 API 返回的工作空间元数据。

字段名称	类型	描述
name	STRING	唯一的工作空间名称。此字段为必填项。
description	STRING	可选的工作区描述。
default_artifact_root	STRING	此工作空间可选的默认制品根路径覆盖。
trace_archival_config	追踪归档配置	此工作空间可选的追踪存档设置。

AggregationType

指标的聚合类型。

名称	描述
COUNT	实体计数。
SUM	值求和。
AVG	值平均值。
PERCENTILE	百分位数聚合（需要 percentile_value 参数）。
MIN	最小值。
MAX	最大值。

BudgetAction

超出预算时采取的措施。

名称	描述
BUDGET_ACTION_UNSPECIFIED
ALERT
REJECT

BudgetDurationUnit

预算策略固定窗口的持续时间单位。

名称	描述
DURATION_UNIT_UNSPECIFIED
MINUTES
HOURS
DAYS
WEEKS
MONTHS

BudgetTargetScope

预算策略的目标范围。

名称	描述
TARGET_SCOPE_UNSPECIFIED
GLOBAL
WORKSPACE

BudgetUnit

预算测量单位。

名称	描述
BUDGET_UNIT_UNSPECIFIED
USD

DeploymentJobRunState

名称	描述
DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED
NO_VALID_DEPLOYMENT_JOB_FOUND
RUNNING
SUCCEEDED
FAILED
PENDING
APPROVAL

FallbackStrategy

路由的后备策略（面向未来，支持其他策略）。

名称	描述
FALLBACK_STRATEGY_UNSPECIFIED
SEQUENTIAL	顺序后备：按指定顺序尝试模型。

GatewayModelLinkageType

端点与模型定义之间的链接类型。

名称	描述
LINKAGE_TYPE_UNSPECIFIED
PRIMARY	主链接：用于路由流量。
FALLBACK	后备链接：用于故障转移。

GuardrailAction

护栏是阻止还是修改请求/响应。

名称	描述
GUARDRAIL_ACTION_UNSPECIFIED
VALIDATION
SANITIZATION

GuardrailStage

护栏是在 LLM 调用之前还是之后运行。

名称	描述
GUARDRAIL_STAGE_UNSPECIFIED
BEFORE
AFTER

JobStatus

MLflow 作业的通用状态枚举。可用于不同的作业类型（优化、评分器等）。

名称	描述
JOB_STATUS_UNSPECIFIED
JOB_STATUS_PENDING	作业已排队，等待开始。
JOB_STATUS_IN_PROGRESS	作业正在运行。
JOB_STATUS_COMPLETED	作业成功完成。
JOB_STATUS_FAILED	作业因错误失败。
JOB_STATUS_CANCELED	作业已被用户取消。

LoggedModelStatus

LoggedModelStatus 枚举值表示已记录模型的状态。

名称	描述
LOGGED_MODEL_STATUS_UNSPECIFIED
LOGGED_MODEL_PENDING	LoggedModel 已创建，但 LoggedModel 文件尚未完全上传。
LOGGED_MODEL_READY	LoggedModel 已创建，且 LoggedModel 文件已完全上传。
LOGGED_MODEL_UPLOAD_FAILED	LoggedModel 已创建，但在上传 LoggedModel 文件（如模型权重/代理代码）时发生错误。

MetricViewType

指标聚合的视图类型。

名称	描述
TRACES	按追踪级别聚合。
SPANS	按跨度级别聚合。
ASSESSMENTS	按评估级别聚合。

ModelVersionStatus

名称	描述
PENDING_REGISTRATION	注册新模型版本的请求处于待处理状态，服务器正在执行后台任务。
FAILED_REGISTRATION	注册新模型版本的请求失败。
READY	模型版本已就绪，可以使用。

OptimizerType

要使用的优化算法类型。

名称	描述
OPTIMIZER_TYPE_UNSPECIFIED
OPTIMIZER_TYPE_GEPA	GEPA (Genetic Pareto) 优化器 (https://github.com/gepa-ai/gepa)
OPTIMIZER_TYPE_METAPROMPT	MetaPrompt 优化器 - 使用元提示词与 LLM，在单次传递中改进提示词。

RoutingStrategy

端点的路由策略。

名称	描述
ROUTING_STRATEGY_UNSPECIFIED
REQUEST_BASED_TRAFFIC_SPLIT	基于请求的流量分配：根据权重分配流量。

RunStatus

运行的状态。

名称	描述
RUNNING	运行已发起。
SCHEDULED	运行计划在稍后时间运行。
FINISHED	运行已完成。
FAILED	运行执行失败。
KILLED	运行被用户终止。

SourceType

生成运行的源。

名称	描述
NOTEBOOK	Databricks 笔记本环境。
JOB	计划作业或立即运行作业。
PROJECT	作为预打包项目：Docker 镜像或 GitHub 源等。
LOCAL	本地运行：使用 CLI、IDE 或本地笔记本。
UNKNOWN	未知的源类型。

SourceType

评估来源的类型。

名称	描述
SOURCE_TYPE_UNSPECIFIED
HUMAN	来自人类的评估。
LLM_JUDGE	来自 LLM 评估器的评估。
CODE	基于代码的评估（例如 Python UDF）。

SourceType

数据集记录来源的类型。

名称	描述
SOURCE_TYPE_UNSPECIFIED
TRACE	来自追踪/跨度的记录。
HUMAN	来自人类注释的记录。
DOCUMENT	来自文档的记录。
CODE	来自代码/计算的记录。

State

记录时追踪的执行状态。

名称	描述
STATE_UNSPECIFIED
OK	被追踪的操作已成功。
ERROR	被追踪的操作失败。
IN_PROGRESS	被追踪的操作仍在进行中。这对于增量/分布式追踪记录非常有用，与仅在完成时记录完整追踪的情况相反。

State

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

TraceLocationType

名称	描述
TRACE_LOCATION_TYPE_UNSPECIFIED
MLFLOW_EXPERIMENT
INFERENCE_TABLE

TraceStatus

名称	描述
TRACE_STATUS_UNSPECIFIED
OK	被追踪的操作已成功。
ERROR	被追踪的操作失败。
IN_PROGRESS	被追踪的操作仍在进行中。

ViewType

ListExperiments 查询的视图类型。

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

WebhookAction

Webhook 操作类型。

名称	描述
ACTION_UNSPECIFIED
CREATED
UPDATED
DELETED
SET
EXCEEDED

WebhookEntity

Webhook 实体类型。

名称	描述
ENTITY_UNSPECIFIED
REGISTERED_MODEL
MODEL_VERSION
MODEL_VERSION_TAG
MODEL_VERSION_ALIAS
PROMPT
PROMPT_VERSION
PROMPT_TAG
PROMPT_VERSION_TAG
PROMPT_ALIAS
BUDGET_POLICY

WebhookStatus

Webhook 状态枚举。

名称	描述
ACTIVE
DISABLED