试运行自定义算子¶
使用给定输入执行一次自定义算子测试,并返回本次测试记录。仅已启用的 Python 代码类型算子可以试运行。
POST https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID/test-run
调用前准备¶
先查询自定义算子详情,确认要测试的算子已启用且为 Python 代码类型。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和自定义算子 ID。
下方示例使用:
$AI_STUDIO_API_KEY:实际个人访问令牌,通过X-API-KeyHeader 传递。$WORKSPACE_ID:目标工作区 ID,通过X-Workspace-IDHeader 传递。$OPERATOR_ID:要试运行的自定义算子 ID,从查询自定义算子列表响应中取得,并写入请求地址。
路径参数¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
要试运行的自定义算子 ID,必须大于 |
请求体¶
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
object |
否 |
测试输入;省略时使用空对象。 |
|
integer |
否 |
等待测试结果的秒数。 |
请求示例¶
curl -X POST "https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/$OPERATOR_ID/test-run" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H "Content-Type: application/json" \
-d '{
"input": {
"text": "MatrixOne"
},
"wait_timeout_seconds": 30
}'
成功响应¶
响应返回本次测试记录。检查测试状态、输出和错误信息,以确认算子是否按预期运行。
{
"code": "OK",
"msg": "OK",
"data": {
"test_run": {
"operator_id": 123,
"node_id": "moi:custom.operator:workspace:text_counter",
"version": "v1",
"task_id": "task_01",
"case_id": "case_01",
"status": "succeeded",
"runtime_input": {
"text": "MatrixOne"
},
"runtime_output": {
"count": 9
}
}
}
}
响应字段如下。
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
integer |
本次测试的自定义算子 ID。 |
|
string |
本次测试使用的算子 ID。 |
|
string |
本次测试使用的算子版本。 |
|
string |
本次测试任务 ID。 |
|
string |
本次测试记录 ID。 |
|
string |
测试运行状态。 |
|
string |
测试案例结果;有值时返回。 |
|
object |
实际输入;有值时返回。 |
|
object |
实际输出;有值时返回。 |
|
string |
测试错误信息;有错误时返回。 |
|
object |
本次测试中算子的执行节点详情;有值时返回。 |
|
string |
执行节点所属流程。 |
|
string |
执行节点名称。 |
|
string |
执行节点标识。 |
|
string |
执行节点类型。 |
|
string |
执行节点显示名称。 |
|
string |
工作项标识;有值时返回。 |
|
string |
节点执行标识;有值时返回。 |
|
string |
节点执行状态。 |
|
string |
开始时间;有值时返回。 |
|
string |
结束时间;有值时返回。 |
|
string |
执行错误;有值时返回。 |
|
integer |
节点执行耗时,单位为毫秒;有值时返回。 |
|
object |
节点实际输入。 |
|
object |
节点实际输出。 |
|
object |
节点配置。 |
|
object |
节点运行变量;有值时返回。 |
|
object |
节点运行指标;有值时返回。 |
|
object |
节点开发日志;有值时返回。 |
|
object |
开发日志;服务提供时返回。 |
|
integer |
本次测试等待结果的秒数。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "请求参数无效",
"data": null
}
常见 HTTP 错误¶
HTTP 状态码 |
错误代码 |
常见原因 |
建议操作 |
|---|---|---|---|
|
|
算子 ID 或请求体无效,算子未启用,或算子不是可试运行的 Python 代码类型。 |
检查算子配置和测试输入。 |
|
|
个人访问令牌缺失或无效。 |
检查个人访问令牌和工作区 ID。 |
|
|
当前身份没有试运行权限。 |
使用有权限的凭据,或联系管理员授权。 |
|
|
算子不存在。 |
检查算子 ID。 |
|
|
服务暂时无法执行测试。 |
记录错误信息后重试。 |
|
|
依赖服务暂时不可用。 |
稍后重试。 |
后续操作¶
完成后查询自定义算子详情确认当前状态。