查询模型列表
Action ListModels
简介
此接口用于查询生图模型列表
请求
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | String | 对应的 API 指令名称 | ✓ |
| PublicKey | String | 用户公钥，可从 PICPIK用户中心 (opens in a new tab) 获取 | ✓ |
| Signature | String | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | ✓ |
| request_uuid | String | 请求uuid，采用uuid生成方式随机生成，可用于管理您业务和客户的请求 |
请求示例
{
"Action": "ListModels",
"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
"request_uuid":"b91fcfbe-bb35-47ce-a168-bd6252c75270",
"Signature": "0131f4e4296f3ca8e1220b47247e83a4315ea8e1"
}响应
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | Int | 返回状态码，为 0 则为成功返回，非 0 为失败 | ✓ |
| Action | String | 操作指令名称 | ✓ |
| Message | String | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | |
| request_uuid | String | 返回请求时填写的uuid |
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| MainModels | Map[String]Model | 主模型 | ✓ |
| LoraModels | Map[String]Model | Lora模型 | |
| EmbeddingModels | Map[String]Model | Embedding模型 | |
| HypernetworkModels | Map[String]Model | Hypernetwork模型 |
复杂数据类型说明
Model
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Name | String | 模型名称 | |
| ModelCode | String | 模型编码 | ✓ |
| IsOfficial | Bool | 是否为官方模型 | |
| TriggerWordList | []String | 触发词列表（仅模型为lora时生效） | |
| InferenceParams | InferenceParams | 推理用的参数 |
InferenceParams
注意：特定参数仅对某个特定的模型数据类型（父级）生效，并不通用。
| 参数名 | 类型 | 有效的父级类型 | 描述信息 | 默认值 | 范围 | 步长 | 必填 |
|---|---|---|---|---|---|---|---|
| LoraWeight | Float | Model | 推理时的模型权重， 仅对 LoRA模型生效 | 1 | -1～2 | 0.01 | |
| Resolution | Int | PreProcessor | Controlnet预处理器的生成分辨率 | 512 | 64~2048 | 64 | |
| ControlWeight | Float | ControlModel | ControlNet模型的推理权重 | 1 | 0~2 | 0.01 | |
| StartingStep | Float | ControlModel | ControlNet模型开始介入推理的时机（比率） | 0 | 0~1 | 0.01 | |
| EndingStep | Float | ControlModel | ControlNet模型退出推理过程的时机（比率） | 1 | 0~1 | 0.01 |
响应示例
{
"Action": "ListModels",
"RetCode": 0,
"Message": "",
"request_uuid": "84a53e05-5db6-432a-a15a-184b8c934858",
"MainModels": {
"PICPIK 3D icon": {
"Name": "三维图标",
"ModelCode": "PICPIK 3D icon",
"ModelType": "",
"IsOfficial": true,
"InferenceParams": {
"LoraWeight": 0
}
},
"PICPIK Anime": {
"Name": "动漫",
"ModelCode": "PICPIK Anime",
"ModelType": "",
"IsOfficial": true,
"InferenceParams": {
"LoraWeight": 0
}
},
//more...
},
"LoraModels": {
"SubModel1_20230801_151342": {
"Name": "SubModel1_20230801_151342",
"ModelCode": "SubModel1_20230801_151342",
"ModelType": "",
"IsOfficial": false
},
//more...
}
}