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

列举模型

功能介绍

列举模型

URI

GET /v1/koosearch/models/search

表1 Query参数

参数

是否必选

参数类型

描述

model_name

否

String

模型名称

最小长度：1

最大长度：64

model_type

否

String

模型类型，枚举值：embedding,rerank,nlp,search-plan,query2query

最小长度：1

最大长度：64

model_status

否

String

模型状态

最小长度：1

最大长度：64

page_num

否

Integer

请求页码

最小值：1

最大值：65535

缺省值：1

page_size

否

Integer

请求限定响应结果的分页大小，例如5条/页，10条/页

最小值：1

最大值：65535

缺省值：10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：1000000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

models

Array of ModelInfo objects

模型列表

数组长度：1 - 65535

total

Integer

返回总条数

最小值：1

最大值：65535

page_num

Integer

页码

最小值：1

最大值：65535

page_size

Integer

每页返回数量

最小值：1

最大值：65535
表4 ModelInfo

参数

参数类型

描述

name

String

模型名称

最小长度：1

最大长度：64

detail

String

模型详情

最小长度：1

最大长度：512

type

String

模型类型

最小长度：1

最大长度：64

endpoint

String

模型endpoint

最小长度：1

最大长度：512

status

String

模型状态

最小长度：1

最大长度：32

create_time

String

模型创建时间

最小长度：1

最大长度：13

update_time

String

模型更新时间

最小长度：1

最大长度：13

extend_config

ModelExtendConfig object

模型扩展配置

alias

String

昇腾模型请求时使用的名称

最小长度：1

最大长度：64
表5 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大模型相关配置
表6 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
表7 VectorConfig

参数

参数类型

描述

embedding_url

String

embedding或query2query模型的调用url

最小长度：1

最大长度：512

rerank_url

String

rerank模型的调用url

最小长度：1

最大长度：512
表8 NlpConfig

参数

参数类型

描述

context_length

Integer

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

最小值：4

最大值：128

缺省值：4

请求示例

无

响应示例

状态码： 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

内部异常

错误码

请参见错误码。

父主题： 模型管理

相关文档