Skip to content

删除模型配置

接口信息

接口地址:/api/v1/system/model/{modelId}/delete

请求方式:POST

请求数据类型:

响应数据类型:*/*

接口描述:

删除指定模型的配置信息。默认模型不允许删除。

注意:请勿删除系统现有数据,建议先通过 /api/v1/system/model/add 创建测试模型再进行删除操作。

请求示例:

POST /api/v1/system/model/100000002/delete

请求参数

请求头

参数名类型必填描述示例值
AuthorizationstringAPI KeyBearer ak-xxxxeyJhbGciOiJIUzI1NiJ9

路径参数:

参数名称参数说明是否必须数据类型
modelId模型IDinteger(int64)

响应参数:

参数名称参数说明类型schema
code业务状态码,0000 表示成功,其余失败string
displayCode源系统状态码,用于问题跟踪string
message错误描述信息string
data返回的具体业务数据object
tid跟踪唯一标识string
successboolean

响应示例:

javascript
{
	"code": "0000",
	"displayCode": "0000",
	"message": "成功",
	"data": null,
	"tid": "5531291776081066058",
	"success": true
}

CURL示例

shell
curl 'http://127.0.0.1:8081/api/v1/system/model/100000002/delete' \
  -X POST \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"code":"0000","displayCode":"0000","message":"成功","data":null,"tid":"3401601776082479114","success":true}

测试用例

#场景状态码结果
1删除新创建的模型0000成功

删除新创建的模型

先通过添加模型接口创建测试模型,再进行删除:

shell
curl 'http://127.0.0.1:8081/api/v1/system/model/add' \
  -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0' \
  --data-raw '{
  "name": "删除测试模型",
  "model": "gpt-delete-test-99",
  "type": "Chat",
  "apiProtocol": "OpenAI",
  "strategy": "RoundRobin",
  "apiInfoList": [
    {"url": "https://api.test.com", "key": "sk-delete-99", "weight": 1}
  ],
  "enabled": 1
}'

{"code":"0000","displayCode":"0000","message":"success","data":100000002,"tid":"4914911776082381653","success":true}
shell
curl 'http://127.0.0.1:8081/api/v1/system/model/100000002/delete' \
  -X POST \
  -H 'Authorization: Bearer ak-d1f2129c4ba24629b8448af3354f9dd0'

{"code":"0000","displayCode":"0000","message":"成功","data":null,"tid":"3401601776082479114","success":true}

TS模板示例

ts
// 响应接口
export interface DeleteModelRes {
  code: string;
  displayCode: string;
  message: string;
  data: object | null;
  tid: string;
  success: boolean;
}

/** 
 * 删除模型配置
 * @param {number} modelId - 模型ID
 * @returns
 */
export function deleteModel(modelId: number): Promise<DeleteModelRes> {
  return request.post(`/api/v1/system/model/${modelId}/delete`);
}