试运行自定义算子

使用给定输入试运行一个已启用的 Python 代码类型自定义算子,并返回本次运行的状态、结果或错误。

POST https://moi.matrixorigin.cn/newmoi/workflow/v2/custom-operators/{operator_id}/test-run

调用前准备

查看自定义算子列表取得自定义算子 ID;再查看自定义算子详情,确认该算子已启用且为 Python 代码类型。准备具有目标工作区访问权限的个人访问令牌目标工作区 ID

请求体

$AI_STUDIO_API_KEY$WORKSPACE_ID$OPERATOR_ID 和试运行输入替换为实际值。

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
  }'

参数

类型

是否必填

说明

operator_id

integer

要试运行的自定义算子 ID,位于请求路径中。

input

object

测试输入;省略时使用空对象。

wait_timeout_seconds

integer

等待测试结果的秒数;省略或小于等于 0 时等待 30 秒,最长为 120 秒。

成功响应

响应返回本次运行的状态、输出和错误信息。

{
  "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
      }
    }
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

object

响应数据。

test_run

object

本次试运行的结果。

下面表格展开响应示例中 data 下的 test_run 对象;每一行是该对象的一个字段。

字段

类型

说明

operator_id

integer

本次试运行的自定义算子 ID。

node_id

string

工作流中的算子 ID。

version

string

算子版本。

task_id

string

运行任务 ID。

case_id

string

运行案例 ID。

status

string

本次运行状态。

case_result

string

运行结果文本;有值时返回。

case_error

string

运行错误信息;有错误时返回。

runtime_input

object

实际运行输入;有值时返回。

runtime_output

object

运行输出;有值时返回。

wait_timeout_seconds

integer

实际等待结果的秒数。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

需要确认算子配置时,使用同一自定义算子 ID 查看自定义算子详情

最后更新于