更新时间:2024-12-20 GMT+08:00
分享

列举模型

功能介绍

列举模型。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET https://localhost.com/v1/workspaces/{workspace_id}/models

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

String

  • 参数解释:工作空间ID。获取方法,请参见获取工作空间ID

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

  • 参数解释:偏移量,表示从此偏移量开始查询。

  • 约束限制:不涉及。

  • 取值范围:offset大于等于0。

  • 默认取值:默认为0。

limit

Integer

  • 参数解释:指定每一页返回的最大条目数。

  • 约束限制:不涉及。

  • 取值范围:取值范围[1,100]。

  • 默认取值:默认为10。

name

String

通过名字搜索Model,支持模糊查询。

id

String

通过模型ID检索,32~36位的英文、数字、中划线(-)组合。获取方法,请参见获取模型ID

type

String

通过模型类型检索。

visibility

String

可见性检索的参数,可选值为:

  • PRIVATE: 私有,用户自己创建的;

  • PUBLIC:公共,查询所有公共的,包括其他用户创建的;

  • ALL: 所有的;

  • 默认为空,不填表示不限制,则查出当前用户下的,包括PRIVATE和PUBLIC,不包括其他用户创建的。

sort_by

String

指定排序字段,可选值为:

  • CREATE_TIME:创建时间,默认值

  • UPDATE_TIME:更新时间

  • NAME: 服务名称

order_by

String

排序方式,可选值如下:

  • ASC : 递增排序

  • DESC: 递减排序,默认值

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

  • 参数解释:租户Token。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

符合条件的总数。

models

Array of ModelInfo objects

列表信息。

表5 ModelInfo

参数

参数类型

描述

visibility

String

  • 参数解释:可见性。

  • 约束限制:不涉及。

  • 取值范围

    • PRIVATE:私有

    • PUBLIC:公共

  • 默认取值:PRIVATE。

id

String

  • 参数解释:模型ID。

  • 约束限制:获取方法,请参见获取模型ID

  • 取值范围:32~36位的英文、数字、中划线(-)组合。

  • 默认取值:不涉及。

name

String

  • 参数解释:一个Model的名称。

  • 约束限制:不涉及。

  • 取值范围:只能包含中文、字母、数字、下划线、中划线、半角句号(.)、空格。

  • 默认取值:不涉及。

description

String

  • 参数解释:描述信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

type

String

  • 参数解释:模型的类型。

  • 约束限制:不涉及。

  • 取值范围

    • LLM_MODEL:大语言模型。

  • 默认取值:不涉及。

create_time

String

  • 参数解释:创建时间。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

update_time

String

  • 参数解释:更新时间。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

current_version

ModelVersionInfo object

Model Version详情信息。

create_user

User object

租户信息。

update_user

User object

租户信息。

表6 ModelVersionInfo

参数

参数类型

描述

id

String

  • 参数解释:模型版本ID。

  • 约束限制:系统自动生成无法修改,输入不生效。

  • 取值范围:32~36位的英文、数字、中划线(-)组合。

  • 默认取值:不涉及。

name

String

  • 参数解释:模型版本名称。

  • 约束限制:只能包含中文、字母、数字、下划线、中划线、半角句号(.)、空格。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

cap_white_list

Array of strings

cap白名单。

description

String

  • 参数解释:描述信息。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

config

ModelConfig object

模型配置。

create_time

String

  • 参数解释:创建时间。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

create_user

User object

租户信息。

表7 ModelConfig

参数

参数类型

描述

llm_model_config

LlmModelConfig object

Llm模型配置。

表8 LlmModelConfig

参数

参数类型

描述

base_model_type

String

  • 参数解释:基模型类型。

  • 约束限制:不涉及。

  • 取值范围:请从ListBaseModels列举基模型接口响应中获取。

  • 默认取值:不涉及。

model_path

String

  • 参数解释:模型文件路径。

  • 约束限制:合法OBS路径。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表9 User

参数

参数类型

描述

domain_name

String

  • 参数解释:账户名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

domain_id

String

  • 参数解释:账号ID。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

user_name

String

  • 参数解释:用户名称。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

user_id

String

  • 参数解释:用户ID。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 408

表13 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:该值不可修改。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

请求示例

响应示例

状态码

状态码

描述

200

查询模型列表的响应体。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

404

Not found error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码

相关文档