文档首页/ Flexus云服务_Flexus企业搜索服务/ API参考/ 模型管理/ 新增模型
更新时间：2024-08-27 GMT+08:00
查看PDF
分享

新增模型

功能介绍

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

URI

POST /v1/koosearch/models

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token

最小长度：1

最大长度：1000000
表2 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

模型名称

最小长度：1

最大长度：32

detail

是

String

模型描述

最小长度：1

最大长度：512

endpoint

是

String

模型endpoint

最小长度：1

最大长度：512

type

是

String

模型类型 pangu_chat 盘古对话模型 pangu_llm 盘古裸机模型 embedding 向量模型 query2query query2query模型 rerank 精排模型 search_plan 搜索规划模型 llm 原生模型

最小长度：1

最大长度：64

枚举值：

  • pangu_chat

  • pangu_llm

  • embedding

  • query2query

  • rerank

  • search_plan

  • llm

extend_config

是

ModelExtendConfig object

模型的自定义配置，json格式

alias

否

String

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

最小长度：1

最大长度：32
表3 ModelExtendConfig

参数

是否必选

参数类型

描述

iam_info

是

IamInfo object

iam鉴权委托信息

custom_header

否

map<string, object>

扩展请求头

deployment_id

否

String

模型的deployment_id信息

最小长度：1

最大长度：128

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是为必填字段

最小长度：1

最大长度：256

domain_name

否

String

委托账号的账号名

最小长度：1

最大长度：256

agency_name

否

String

委托名

最小长度：1

最大长度：256
表5 VectorConfig

参数

是否必选

参数类型

描述

embedding_url

是

String

embedding或query2query模型的调用url

最小长度：1

最大长度：512

rerank_url

是

String

rerank模型的调用url

最小长度：1

最大长度：512
表6 NlpConfig

参数

是否必选

参数类型

描述

context_length

是

Integer

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

最小值：4

最大值：128

缺省值：4

响应参数

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

/v1/111/applications/222/uni-search/nlp-models

{
  "name" : "pangu_38b",
  "detail" : "pangu_38b",
  "type" : "nlp",
  "endpoint" : "http://10.0.0.169:31010",
  "extend_config" : {
    "deployment_id" : "123",
    "iam_info" : {
      "iam_enabled" : false,
      "agency_enabled" : false
    }
  }
}

响应示例

无

状态码

状态码

描述

200

新增成功

400

请求体错误

500

内部异常

错误码

请参见错误码。

父主题： 模型管理

相关文档