# 新增模型
#### 功能介绍
新增配置模型，包括模型名称、模型描述、模型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。                                                                                                        |
   
 表3ModelExtendConfig 
| 参数            | 是否必选 | 参数类型                                                         | 描述                  |
|:---|:---|:---|:---|
| iam_info      | 是    | [IamInfo] object           | iam鉴权委托信息。          |
| custom_header | 否    | map\<string, object\>                                        | 扩展请求头。              |
| deployment_id | 否    | String                                                       | 模型的deployment_id信息。 |
| vector_config | 否    | [VectorConfig] object | 向量模型的相关配置。          |
| nlp_config    | 否    | [NlpConfig] object       | NLP大模型相关配置。         |
   
 表4IamInfo 
| 参数             | 是否必选 | 参数类型    | 描述                                        |
|:---|:---|:---|:---|
| iam_enabled    | 否    | Boolean | 是否启用iam鉴权。                                |
| agency_enabled | 否    | Boolean | 是否使用委托账号进行鉴权。                             |
| project_id     | 否    | String  | iam用户的project_id信息，iam_enable=true是为必填字段。 |
| domain_name    | 否    | String  | 委托账号的账号名。                                 |
| agency_name    | 否    | String  | 委托名。                                      |
   
 表5VectorConfig 
| 参数            | 是否必选 | 参数类型   | 描述                             |
|:---|:---|:---|:---|
| embedding_url | 是    | String | embedding或query2query模型的调用url。 |
| rerank_url    | 是    | String | rerank模型的调用url。                |
   
 表6NlpConfig 
| 参数             | 是否必选 | 参数类型    | 描述                                  |
|:---|:---|:---|:---|
| context_length | 是    | Integer | 上下文长度，即NLP大模型在进行一次特定的推理时可以考虑的最大令牌数。 |
   
#### 响应参数
**状态码：200**
新增成功。
**状态码：400**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                  |
|:---|:---|:---|
| error_code | String | [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html) |
| error_msg  | String | 错误描述                                                                |
   
**状态码：500**
表8响应Body参数 
| 参数         | 参数类型   | 描述                                                                  |
|:---|:---|:---|
| error_code | String | [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html) |
| 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 | 内部异常  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。