跳转至

算法接口

4.9 算法接口(3.7.0)

4.9.1 获取算法列表

Path: /api-asset/algorithms

Method: GET

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型 备注
type query Enum: "client", "cloud", "" Yes string
clientId query 客户端机器 UUID No string 3.7.0
isWindows query 算法运行系统是否是 windows No boolean
projectId query 项目 Id No string
keyword query 搜索关键字 No string
page query 页码 Yes string
pageSize query 每页数量 No string
返回数据
Code 说明 类型
200 Ok AlgorithmListResponse



4.9.2 获取算法版本

Path: /api-asset/algorithms/\({algorithmId}/versions/\)

Method: GET

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
algorithmId path 算法 id Yes string
versionId path 算法版本 id No string
返回数据
Code 说明 类型
200 Ok AlgorithmVersion



4.9.3 获取算法版本列表

Path: /api-asset/algorithms/${algorithmId}/versions

Method: GET

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
algorithmId path 算法 id Yes string
返回数据
Code 说明 类型
200 Ok [AlgorithmVersion]



4.9.4 新增算法

Path: /api-asset/algorithms

Method: POST

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
data body 算法及版本数据 Yes AlgorithmCreateData
sourceId body 上传的算法资源 No string
返回数据
Code 说明 类型
200 Ok { "name": string; "id": string }



4.9.5 更新算法

Path: /api-asset/algorithms/${id}

Method: PUT

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
name body 重名名时传入 No string
activatedId body 删除当前 activatedId 的算法版本时,需要重置一个 activatedId No string
返回数据
Code 说明 类型
200 Ok { "name": string; "id": string }



4.9.6 删除算法

Path: /api-asset/algorithms/delete

Method: POST

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
ids body 需要删除的算法 id No string[]
返回数据
Code 说明 类型
200 Ok



4.9.7 算法名称是否已经存在

Path: /api-asset/algorithms/exists/{name}

Method: GET

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
name path 名称 Yes string
返回数据
Code 说明 类型
200 Ok { "exists": string; "id": string }



4.9.8 添加算法版本

Path: /api-asset/algorithms/${id}/versions

Method: POST

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
id path 算法 id Yes string
data body 算法版本数据 Yes Partial<AlgorithmVersion>
sourceId body 上传的算法资源 No string
返回数据
Code 说明 类型
200 Ok { "name": string; "id": string }



4.9.9 删除版本

Path: /api-asset/algorithms/versions/delete

Method: POST

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
ids body 算法版本 id 列表 Yes string[]
返回数据
Code 说明 类型
200 Ok



4.9.10 算法版本是否存在

Path: /api-asset/algorithms/\({algorithmId}/exists/\)

Method: GET

Headers:Headers

请求参数
参数名称 传参格式 说明 是否必填 类型
algorithmId path 算法 id Yes string
version path 算法版本 Yes string
返回数据
Code 说明 类型
200 Ok { "exists": string; "id": string }