列举模型
功能介绍
列举模型。
URI
GET /v1/koosearch/models/search
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
model_name |
否 |
String |
模型名称。 |
|
model_type |
否 |
String |
模型类型。枚举值：embedding,rerank,nlp,search-plan,query2query |
|
model_status |
否 |
String |
模型状态。 |
|
page_num |
否 |
Integer |
请求页码。 |
|
page_size |
否 |
Integer |
请求限定响应结果的分页大小，例如5条/页，10条/页。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 接口鉴权使用的Token，Token获取方式参考：3.2节 认证鉴权。 约束限制： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
models |
Array of ModelInfo objects |
模型列表。 |
|
total |
Integer |
返回总条数。 |
|
page_num |
Integer |
页码。 |
|
page_size |
Integer |
每页返回数量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
模型名称。 |
|
detail |
String |
模型详情。 |
|
type |
String |
模型类型。 |
|
endpoint |
String |
模型endpoint。 |
|
status |
String |
模型状态。 |
|
create_time |
String |
模型创建时间。 |
|
update_time |
String |
模型更新时间。 |
|
extend_config |
ModelExtendConfig object |
模型扩展配置。 |
|
alias |
String |
昇腾模型请求时使用的名称。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
iam_info |
IamInfo object |
iam鉴权委托信息。 |
|
custom_header |
map<string, object> |
扩展请求头。 |
|
deployment_id |
String |
模型的deployment_id信息。 |
|
vector_config |
VectorConfig object |
向量模型的相关配置。 |
|
nlp_config |
NlpConfig object |
NLP大模型相关配置。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
iam_enabled |
Boolean |
是否启用iam鉴权。 |
|
agency_enabled |
Boolean |
是否使用委托账号进行鉴权。 |
|
project_id |
String |
iam用户的project_id信息，iam_enable=true是为必填字段。 |
|
domain_name |
String |
委托账号的账号名。 |
|
agency_name |
String |
委托名。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
embedding_url |
String |
embedding或query2query模型的调用url。 |
|
rerank_url |
String |
rerank模型的调用url。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
|
|
error_msg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
|
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
模型列表。
{
"page_num" : 1,
"page_size" : 1,
"total" : 1,
"models" : [ {
"name" : "pangu_38b",
"detail" : "pangu_38b",
"type" : "nlp",
"status" : "ready",
"create_time" : "1716946517167",
"update_time" : "1716946517167",
"endpoint" : "http://10.0.0.169:31010",
"extend_config" : {
"deployment_id" : "123",
"iam_info" : {
"iam_enabled" : false,
"agency_enabled" : false,
"project_id" : "456"
}
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
模型列表。 |
|
400 |
请求体参数错误 |
|
500 |
内部异常 |
错误码
请参见错误码。
