列举模型
功能介绍
列举模型。
URI
GET /v1/{project_id}/applications/{application_id}/uni-search/models/search
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
model_name |
否 |
String |
参数解释: 模型名称。 约束限制: 不涉及 取值范围: 长度在1到64之间,且只能包含字母、数字、下划线、点和短横线。 默认取值: 不涉及 |
model_type |
否 |
String |
参数解释: 模型类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
model_status |
否 |
String |
参数解释: 模型状态。 约束限制: 不涉及 取值范围: 只能包含字母、短横线、逗号和下划线。 默认取值: 不涉及 |
page_num |
否 |
Integer |
参数解释: 当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。 约束限制: 不涉及 取值范围: 1~65535 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。 约束限制: 不涉及 取值范围: 1-65535 默认取值: 10 |
create_user |
否 |
String |
参数解释: 创建者筛选。 约束限制: 不涉及 取值范围: 最大长度为64。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
page_num |
Long |
参数解释: 页数。 取值范围: 不涉及 |
page_size |
Long |
参数解释: 条数。 取值范围: 不涉及 |
total |
Long |
参数解释: 模型总条数。 取值范围: 不涉及 |
models |
Array of ModelListInfo objects |
参数解释: 模型信息数据。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 模型名称。 取值范围: 不涉及 |
project_id |
String |
参数解释: 项目ID。 取值范围: 不涉及 |
alias |
String |
参数解释: 昇腾模型请求时使用的名称。 取值范围: 不涉及 |
detail |
String |
参数解释: 模型详情。 取值范围: 不涉及 |
type |
String |
参数解释: 模型类型。 取值范围: 不涉及 |
status |
String |
参数解释: 模型状态。 取值范围: 不涉及 |
endpoint |
String |
参数解释: 模型endpoint。 取值范围: 不涉及 |
create_time |
String |
参数解释: 模型创建时间。 取值范围: 不涉及 |
update_time |
String |
参数解释: 模型更新时间。 取值范围: 不涉及 |
extend_config |
ModelExtendConfig object |
参数解释: 模型扩展配置。 取值范围: 不涉及 |
actions |
Array of strings |
参数解释: 权限列表。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
context_length |
Integer |
参数解释: 上下文长度,即NLP大模型在进行一次特定的推理时可以考虑的最大令牌数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
列举模型。
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/models/search?page_num=1&page_size=10
响应示例
状态码: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 |
内部异常。 |
错误码
请参见错误码。