更新时间:2025-07-22 GMT+08:00
分享

新增模型

功能介绍

新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。

URI

POST /v1/koosearch/models

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:3.2节 认证鉴权。

约束限制:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

模型名称。

detail

String

模型描述。

endpoint

String

模型endpoint。

type

String

模型类型:

pangu_chat 盘古对话模型

pangu_llm 盘古裸机模型

embedding 向量模型

query2query query2query模型

rerank 精排模型

search_plan 搜索规划模型

llm 原生模型

extend_config

ModelExtendConfig object

模型的自定义配置,json格式。

alias

String

昇腾模型场景请求模型需要的name。

表3 ModelExtendConfig

参数

是否必选

参数类型

描述

iam_info

IamInfo object

iam鉴权委托信息。

custom_header

map<string, object>

扩展请求头。

deployment_id

String

模型的deployment_id信息。

vector_config

VectorConfig object

向量模型的相关配置。

nlp_config

NlpConfig object

NLP大模型相关配置。

表4 IamInfo

参数

是否必选

参数类型

描述

iam_enabled

Boolean

是否启用iam鉴权。

agency_enabled

Boolean

是否使用委托账号进行鉴权。

project_id

String

iam用户的project_id信息,iam_enable=true是为必填字段。

domain_name

String

委托账号的账号名。

agency_name

String

委托名。

表5 VectorConfig

参数

是否必选

参数类型

描述

embedding_url

String

embedding或query2query模型的调用url。

rerank_url

String

rerank模型的调用url。

表6 NlpConfig

参数

是否必选

参数类型

描述

context_length

Integer

上下文长度,即NLP大模型在进行一次特定的推理时可以考虑的最大令牌数。

响应参数

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/koosearch/models

{
  "name" : "pangu_v30_32k",
  "type" : "pangu_llm",
  "endpoint" : "http://10.0.0.169:31010",
  "detail" : "panguv30_4k",
  "extend_config" : {
    "deployment_id" : "panguv30_4k",
    "iam_info" : {
      "project_id" : "123",
      "iam_enabled" : false,
      "agency_enabled" : false
    },
    "nlp_config" : {
      "context_length" : 32
    }
  }
}

响应示例

状态码

状态码

描述

200

新增成功。

400

请求体错误

500

内部异常

错误码

请参见错误码

相关文档