算法schema说明

本文将详细介绍 算法集成 的 schema 的格式, 以及如何根据自己的需求定义 schema.

介绍

每个 算法集成 进程为一个算法服务, 每个服务可以配置多个 算法.

算法集成 的 schema 就是用于定义 算法集成 的配置信息, 其中包括 算法名, 输入参数 和 输出参数,.

info

算法名与算法一一对应.

输入参数是算法方法执行需要的参数列表.

输出参数是算法方法执行后的返回值格式.

格式介绍

schema 内容是 Json Schema, 在 我的算法 页面中, 会根据 schema 的内容动态生成函数列表、输入参数及输出参数. 最外层为数组可以配置多个算法, 每个元素对应一个算法, 如下所示:

[{
    "title": "加法", // 页面显示名称
    "function": "add", // 算法名
    "input": {}, // 输入参数
    "output": {} // 输出参数
}, {
    "title": "绝对值",
    "function": "abs",
    "input": {},
    "output": {}
}]

每个元素配置项中都包含 title, function, input 和 output 3 个部分, 分别对应 页面显示名称, 算法名, 输入参数 和 输出参数. 展开后整体格式如下所示:

[
  {
    "title": "加法",
    "function": "add",
    "input": {
      "type": "object",
      "properties": {
        "num1": {
          "title": "参数1",
          "type": "number"
        },
        "num2": {
          "title": "参数2",
          "type": "number"
        }
      },
      "required": [
        "num1",
        "num2"
      ]
    },
    "output": {
      "type": "object",
      "properties": {
        "num1": {
          "title": "结果",
          "type": "number"
        }
      }
    }
  },
  {
    "title": "绝对值",
    "function": "abs",
    "input": {
      "type": "object",
      "properties": {
        "num1": {
          "title": "参数1",
          "type": "number"
        }
      },
      "required": [
        "num1"
      ]
    },
    "output": {
      "type": "object",
      "properties": {
        "res": {
          "title": "结果",
          "type": "number"
        }
      }
    }
  }
]