文档首页/ 云搜索服务 CSS_企业搜索服务 KooSearch/ API参考/ API/ API/ 模型管理/ 修改模型配置
更新时间：2025-07-22 GMT+08:00
查看PDF
分享

修改模型配置

功能介绍

修改模型配置。

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/models/{model_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。

默认取值：

不涉及

application_id

是

String

参数解释：

应用ID，获取方法请参见获取应用ID。

约束限制：

字符串

取值范围：

1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。

默认取值：

不涉及

model_name

是

String

参数解释：

模型名称。

约束限制：

不涉及

取值范围：

长度在1到64之间，且只能包含字母、数字、下划线、点和短横线。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

detail

否

String

参数解释：

模型描述。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

endpoint

否

String

参数解释：

模型endpoint。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

extend_config

否

ModelExtendConfig object

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

alias

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 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大模型相关配置。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

guard_enabled

否

Boolean

参数解释：

是否开启审核。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

query_key

否

String

参数解释：

query请求体的key值。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_param

否

Map<String,String>

参数解释：

请求参数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_enabled

否

Boolean

参数解释：

自定义字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

custom_json_parse

否

Map<String,String>

参数解释：

结果解析。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

proxy_enabled

否

Boolean

参数解释：

是否开启代理，web搜索引擎配置时启用。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

time_detect_enabled

否

Boolean

参数解释：

是否开启定时检测，web搜索引擎配置时启用。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

agree_disclaimer

否

String

参数解释：

已同意免责声明，传入AGREE，默认为空字符串。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

mllm_prompt

否

Map<String,String>

参数解释：

存储多模态的多语种prompt。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表5 IamInfo

参数

是否必选

参数类型

描述

iam_enabled

否

Boolean

参数解释：

是否启用iam鉴权。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

agency_enabled

否

Boolean

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

project_id

否

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

domain_name

否

String

参数解释：

委托账号的账号名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

agency_name

否

String

参数解释：

委托名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表6 VectorConfig

参数

是否必选

参数类型

描述

embedding_url

是

String

参数解释：

embedding或query2query模型的调用url。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

rerank_url

否

String

参数解释：

rerank模型的调用url。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表7 NlpConfig

参数

是否必选

参数类型

描述

context_length

是

Integer

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

新增成功。

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及

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

内部异常。

错误码

请参见错误码。

父主题： 模型管理

相关文档