
# 修改模型配置 - UpdateModels
#### 功能介绍
修改模型配置。
#### URI
PUT /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}
表1路径参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id     | 是    | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0022.html)。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 |
| application_id | 是    | String | **参数解释：** 应用ID，获取方法请参见[获取应用ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0021.html)。 **约束限制：** 字符串 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 |
| model_name     | 是    | String | **参数解释：** 模型名称。 **约束限制：** 不涉及 **取值范围：** 长度在1到64之间，且只能包含字母、数字、下划线、点和短横线。 **默认取值：** 不涉及                                                                                           |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：[获取IAM用户Token](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表3请求Body参数 
| 参数             | 是否必选 | 参数类型                                                                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| detail         | 否    | String                                                               | **参数解释：** 模型描述。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| type           | 否    | String                                                               | **参数解释：** 模型类型。 **约束限制：** 不涉及 **取值范围：** 枚举值： - OCR   - MLLM   - LLM   - PANGU_GUARD   - PANGU_CHAT   - PANGU_LLM   - EMBEDDING   - QUERY2QUERY   - RERANK   - SEARCH_PLAN   - SEARCH_ENGINE   - AI_ENGINE   - MLLM    **默认取值：** 不涉及 |
| interface_type | 否    | String                                                               | **参数解释：** 接口类型 **约束限制：** 不涉及 **取值范围：** - custom：自定义   - open_ai：openAi接口规范    **默认取值：** custom                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| endpoint       | 否    | String                                                               | **参数解释：** 模型endpoint。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| extend_config  | 否    | [ModelExtendConfig] object | **参数解释：** 模型的自定义配置，json格式。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| alias          | 否    | String                                                               | **参数解释：** 请求模型需要的name。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   
 表4ModelExtendConfig 
| 参数                  | 是否必选 | 参数类型                                                       | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| iam_info            | 是    | [IamInfo] object           | **参数解释：** iam鉴权委托信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                    |
| custom_header       | 否    | map\<string, object\>                                      | **参数解释：** 扩展请求头。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                        |
| deployment_id       | 否    | String                                                     | **参数解释：** 模型的deployment_id信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                           |
| vector_config       | 否    | [VectorConfig] object | **参数解释：** 向量模型的相关配置。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                    |
| nlp_config          | 否    | [NlpConfig] object       | **参数解释：** NLP大模型相关配置。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                   |
| guard_enabled       | 否    | Boolean                                                    | **参数解释：** 是否开启审核。 **约束限制：** 不涉及 **取值范围：** - true: 开启内容审核   - false: 不开启内容审核    **默认取值：** true                 |
| query_key           | 否    | String                                                     | **参数解释：** query请求体的key值。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                |
| custom_param        | 否    | Map\<String,String\>                                       | **参数解释：** 请求参数。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                         |
| custom_enabled      | 否    | Boolean                                                    | **参数解释：** 自定义字段。 **约束限制：** 不涉及 **取值范围：** - true: 使用自定义字段   - false: 不使用自定义字段    **默认取值：** false               |
| custom_json_parse   | 否    | Map\<String,String\>                                       | **参数解释：** 结果解析。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                         |
| proxy_enabled       | 否    | Boolean                                                    | **参数解释：** 是否开启代理，web搜索引擎配置时启用。 **约束限制：** 不涉及 **取值范围：** - true: 开启代理模式   - false: 不开启代理模式    **默认取值：** false   |
| time_detect_enabled | 否    | Boolean                                                    | **参数解释：** 是否开启定时检测，web搜索引擎配置时启用。 **约束限制：** 不涉及 **取值范围：** - true: 开启定时检测   - false: 不开启定时检测    **默认取值：** false |
| agree_disclaimer    | 否    | String                                                     | **参数解释：** 已同意免责声明，传入AGREE，默认为空字符串。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                      |
   
 表5IamInfo 
| 参数             | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| iam_enabled    | 否    | Boolean | **参数解释：** 是否启用iam鉴权。 **约束限制：** 不涉及 **取值范围：** - true: 启用iam鉴权   - false: 不启用iam鉴权    **默认取值：** false          |
| agency_enabled | 否    | Boolean | **参数解释：** 是否使用委托账号进行鉴权。 **约束限制：** 不涉及 **取值范围：** - true: 使用委托账号进行鉴权   - false: 不使用委托账号进行鉴权    **默认取值：** false |
| project_id     | 否    | String  | **参数解释：** iam用户的project_id信息，iam_enable=true是为必填字段。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                    |
| domain_name    | 否    | String  | **参数解释：** 委托账号的账号名。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                    |
| agency_name    | 否    | String  | **参数解释：** 委托名。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                         |
   
 表6VectorConfig 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| embedding_url | 是    | String | **参数解释：** embedding或query2query模型的调用url。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| rerank_url    | 否    | String | **参数解释：** rerank模型的调用url。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                |
   
 表7NlpConfig 
| 参数             | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| context_length | 是    | Integer | **参数解释：** 上下文长度，即NLP大模型在进行一次特定的推理时可以考虑的最大令牌数。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应参数
**状态码：200**
新增成功。
**状态码：400**
表8响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及                                                                |
   
**状态码：500**
表9响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及                                                                |
   
#### 请求示例
修改模型配置。
```
/v1/111/applications/222/uni-search/models
{
  "detail" : "pangu_38b",
  "endpoint" : "http://10.0.0.169:31010",
  "extend_config" : {
    "deployment_id" : "123",
    "iam_info" : {
      "iam_enabled" : false,
      "agency_enabled" : false
    }
  }
}
```
#### 响应示例
无
#### 状态码
| 状态码 | 描述     |
|:---|:---|
| 200 | 新增成功。  |
| 400 | 请求体错误。 |
| 500 | 内部异常。  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。
