智能体
更新时间:2024-10-12
概述
智能体是WeShop唯象的核心概念,它代表了针对不同用户需求的智能解决方案。在WeShop唯象中,用户的需求都需要通过选择适用的智能体来实现。每个智能体都包含了详细的说明,用户可以根据这些信息来精确选择匹配需求的智能体。
智能体相关的接口请参考:智能体通用接口,下文列出的所有智能体都需配合智能体通用接口使用。
AI模特
轻松生成多样化的AI数字人模特和专业电商拍摄场景,可适应全球各地市场需求,高效展示商品。
基础信息
AgentName
aimodel
AgentVersion
- v1.0
注意事项
- 执行任务时,在textDescription、locationId、fashionModelId这三个参数中,请至少选择其中一个或者多个参数进行执行。
- 如果您想以自然语言的方式描述需要生成的图像内容,可对参数textDescription赋值。
- 若您倾向于使用智能体的预设最佳实践模板。可提供locationId和fashionModelId参数。您可以通过智能体的info API查询到合法的locationId和fashionModelId的值。
- 蒙板设置
- 如果您只需要保持模特身上的服饰不变,在执行任务时请将maskType设置为“autoApparelSegment”。智能体将使用自动服饰分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您只需要更换背景,而不进行模特更换,在执行任务时请将maskType设置为“autoSubjectSegment”。智能体将使用自动主体分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您需要自主选择保持不变的区域,请在操作之前准备好蒙版图,并在执行任务时将maskType设置为“custom”。在这种情况下,您须提供customMask或customMaskUrl参数。您可以使用weshop-segment sdk (opens in a new tab)编辑选区来生成蒙版图,或者使用其他工具生成所需的蒙版图。
任务
创建任务
请求参数
- initParams
参数样例:
{
"initParams": {
"taskName": "Create Task Api Test",
"originalImage": "https://ai-image.weshop.com/xxxxxxxx.png"
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 否 | string | 任务名称 | 不可超过20个字符 |
originalImage | 是 | string | 待处理的图片上传 | 使用外部图片链接时,须确保图片链接公网可访问 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskId | 是 | string | 任务ID 唯一标识 | / |
执行任务
请求参数
- params
参数样例:
// 自动服饰分割
{
"params": {
"generatedContent": "referToOrigin",
"maskType": "autoApparelSegment",
"locationId": 6000326,
"fashionModelId": 6000195,
"textDescription": "一位年轻的亚洲女性,高度细致的皮肤,逼真的细节眼睛,自然的皮肤纹理,自信的表 情,站在街头,晴天,阳光,明亮,夏日午后,清晰对焦,高品质,iPhone拍摄,超逼真。",
"negTextDescription": "乌云",
}
}
// 自动主体分割
{
"params": {
"generatedContent": "freeCreation",
"maskType": "autoSubjectSegment",
"locationId": 6000326
}
}
// 上传自定义mask
{
"params": {
"generatedContent": "freeCreation",
"maskType": "custom",
"customMask": "<蒙版图base64编码>",
"textDescription": "一位年轻的中国女性,高度细致的皮肤,逼真的细节眼睛,自然的皮肤纹理,自信的表 情,站在街头,晴天,阳光,明亮,夏日午后,清晰对焦,高品质,iPhone拍摄,超逼真。",
"negTextDescription": "乌云",
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
generatedContent | 是 | string | 选择算法倾向: "freeCreation":自由发挥 "referToOrigin":参考原图 | 1. freeCreation自由发挥会使结果图更加自由化,不受上传原图风格的约束 2. referToOrigin参考原图会使结果图的在生成过程中参考上传原图的风格 |
maskType | 是 | string | 选择mask类型: "autoApparelSegment":自动服饰分割 "autoSubjectSegment":自动主体分割 "autoHumanSegment":自动人体分割 "custom":手动上传mask信息 | 1. autoApparelSegment自动服饰分割与网页版的换模特和背景一致 2. autoSubjectSegment自动主体分割为主体背景分割,与网页版的换背景一致,选择该mask类型执行时传入的fashionModelId将不会生效 3. autoHumanSegment自动人体分割与网页版的换模特一致,选择该mask类型执行时传入的locationId将不会生效 4. 手动上传需要确保上传的蒙版图与原图尺寸相同 |
customMask | 否 | string | 上传蒙版图的base64编码 | 1. 当Mask类型为"custom"时,必须上传该参数,否则无需上传 2. 图片除蒙版区域外为透明 3. 使用base64编码,不包含前缀"data:image/png;base64" 4. 需与原图尺寸相同 |
customMaskUrl | 否 | string | 上传蒙版图的链接 | 使用外部图片链接时,须确保图片链接公网可访问,对图片的格式要求与customMask一致 |
locationId | 否 | int | 场景 | 选填 |
locationTagIds | 否 | array[int] | 场景标签 | 选填,详情参考Locations |
fashionModelId | 否 | int | 模特 | 选填 |
fashionModelTagIds | 否 | array[int] | 模特标签 | 选填,详情参考FashionModels |
textDescription | 否 | string | 文字描述的内容 | 选填 |
negTextDescription | 否 | string | 不想出现的内容 | 选填 |
resultImageFormat | 否 | string | 选择生成结果图片的格式,可选项: "jpg" "png" | 默认为png |
resizeToOriginalImage | 否 | bool | 是否将生成结果图片缩放至原图的尺寸 | 默认为false |
batchCount | 否 | int | 设置本次执行生成图片的数量,最小为1,最大为16 | 默认为4,超出范围取默认值 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID 唯一标识 | / |
查询任务
请求参数
- json格式,参数样例
{
"executionId":"<execution id>"
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 否 | string | 任务执行ID | / |
taskId | 否 | string | 任务ID | 如果传入taskId参数,最多返回近20条执行信息 |
响应参数
- initParams
当前任务的初始信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 是 | string | 任务名称 | / |
originalImage | 是 | string | 任务原图链接 | / |
- executions
执行信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID | / |
status | 是 | string | 任务执行状态: Segmenting:自动分割中 Pending:排队中 Running :进行中 Success:已完成 | / |
params | 是 | object | 执行任务相关参数 | / |
executionTime | 是 | string | 任务执行时间点 | / |
results | 是 | array[object] | 任务执行结果信息 | / |
- result
执行结果
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
status | 是 | string | 执行结果枚举值 Running :执行中 Success:执行成功 Failed:执行失败 Pending:等待中 | / |
image | 是 | string | 生成的最终图片 | / |
progress | 否 | string | 处理进度,如:0.71,表示已处理71% | / |
error | 否 | string | 处理失败的信息 | 当status为Failed时,一定会返回 |
信息查询
查询智能体相关信息 传入智能体名称(agentName)和版本号(agentVersion),获得相应的配置参数信息。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
agentName | 是 | string | 智能体名称: "aimodel" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locations | 是 | array[object] | 场景相关参数信息 | 1. 可通过智能体信息查询接口获取完整Locations信息 2. 数据结构请查看Locations |
fashionModels | 是 | array[object] | 模特相关信息参数 | 1. 可通过智能体信息查询接口获取完整FashionModels信息 2. 数据结构请查看FashionModels |
agentVersion | 是 | string | 智能体版本 | / |
Locations
- location数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 场景Id | / |
image | 是 | string | 场景展示图片 | / |
name | 是 | string | 场景名称 | / |
categories | 是 | array[string] | 场景所在类目 | / |
tags | 否 | array[object] | 场景标签 | / |
type | 是 | string | 模特类型: AI:官方提供的场景 Yours:用户自己创建的场景 | / |
status | 否 | string | 用户创建场景的生成状态: prepare:生成准备中 complete:完成 failed:生成失败 | 仅当状态为完成时,才可以使用该场景。 |
- tag数据结构
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 场景Id(locationTagIds) | / |
name | 是 | string | 场景标签名称 | / |
[
{
"id": 6000509,
"image": "https://ai-image.weshop.com/3b930afb-b1db-4999-989a-aa9db0663240_1056x1416.png",
"name": "绿植角落",
"categories": ["室内"],
"tags": [
{
"id": 1002034,
"name": "电影质感"
},
......
{
"id": 1002036,
"name": "聚光灯"
}
]
},
{
"id": 6000456,
"image": "https://ai-image.weshop.com/23f94939-cd2e-455b-8ff0-903afe10742d_1248x1680.png",
"name": "阁楼咖啡馆",
"categories": ["室内"],
"tags": [
{
"id": 1002004,
"name": "春天"
},
......
{
"id": 1002036,
"name": "聚光灯"
}
]
},
......
]
FashionModels
- fashionModel数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 模特Id | / |
image | 是 | string | 模特展示图片 | / |
name | 是 | string | 模特名称 | / |
profile | 否 | object | 模特信息,包括国籍、风格等内容 | / |
type | 是 | string | 模特类型: AI:官方提供的AI模特 Yours:用户自己创建的模特 | / |
tags | 否 | array[object] | 模特标签 | / |
status | 否 | string | 用户创建模特的生成状态: prepare:生成准备中 complete:完成 failed:生成失败 | 仅当状态为完成时,才可以使用该模特。 |
- profile数据结构
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
nationality | 否 | int | 模特国籍 | / |
style | 否 | string | 模特风格 | / |
priceDescription | 否 | string | 模特价格 | / |
- tag数据结构
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 模特标签Id(fashionModelTagIds) | / |
name | 是 | string | 模特标签名称 | / |
[
{
"id": 4020002,
"image": "https://ai-image.weshop.com/b351ddc6-396d-46b2-bf22-e629ddcadae9_935x935.png",
"name": "然然",
"profile": {
"nationality": "中国",
"priceDescription": "额外消耗5算力点/张",
"style": "文艺清冷"
},
"tags": [
{
"id": 1002003,
"name": "微笑"
},
......
{
"id": 1002020,
"name": "时尚高冷"
}
],
"type": "AI"
},
{
"id": 4020241,
"image": "https://ai-image.weshop.com/9ec5a001-0dc4-409c-bf76-399f515a48a1_560x560.png",
"name": "秋秋",
"profile": {
"nationality": "中国",
"priceDescription": "额外消耗5算力点/张",
"style": "文艺清冷"
},
"tags": [
{
"id": 1002003,
"name": "微笑"
},
......
{
"id": 1002020,
"name": "时尚高冷"
}
],
"type": "AI"
},
......
]
扩展接口
我的模特
创建我的模特
POST https://openapi.weshop.com/openapi/v1/agent/myFashionModel/create
传入满足要求的模特图片(images)和模特名称(name)。每个账户最多能创建1000条。
请求参数
- json格式
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
images | 是 | array[object] | 上传的模特图片 | 1. 最多上传4张图片 2. 使用外部图片链接时,须确保图片链接公网可访问 3. 图片的大小不超过5M 4. 图片格式:png,jpeg,jpg,webp 5. 露出完整五官,正面视角,淡妆或素颜为佳 |
name | 否 | string | 模特名称 | 默认:我的模特 x |
agentName | 是 | string | 智能体名称: "aimodel" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
fashionModelId | 是 | int | 我的模特ID | / |
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myFashionModel/create' \
--header 'Authorization: <API密钥>' \
--header 'Content-Type: application/json' \
--data '{
"images": [
"https://ai-image.weshop.com/xxxxxxxx.png"
],
"name": "fashionModelName",
"agentName": "aimodel",
"agentVersion" : "v1.0"
}'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功",
"data": {
"fashionModelId":00000000001
}
}
查询我的模特
GET https://openapi.weshop.com/openapi/v1/agent/myFashionModel/query
传入我的模特ID(fashionModelId)。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
fashionModelId | 是 | string | 我的模特ID | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
fashionModelId | 是 | int | 我的模特ID | / |
name | 是 | string | 模特名称 | / |
cover | 是 | string | 模特封面图 | / |
images | 是 | array[string] | 上传的所有模特图片 | / |
status | 是 | string | 生成模特的状态 prepare:生成准备中 complete:完成 failed:生成失败 | 仅当状态为完成时,才可以使用该模特。 |
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myFashionModel/query?fashionModelId=<我的模特ID>' \
--header 'Authorization: <API密钥>'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功",
"data": {
"cover": "https://ai-image.weshop.com/xxxxxxxx.png",
"fashionModelId": 00000000001,
"images": [
"https://ai-image.weshop.com/xxxxxxxx.png"
],
"name": "fashionModelName",
"status": "complete"
}
}
删除我的模特
POST https://openapi.weshop.com/openapi/v1/agent/myFashionModel/delete
传入我的模特ID(fashionModelId),删除该模特。
请求参数
- json格式
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
fashionModelId | 是 | int | 我的模特ID | / |
响应参数
无
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myFashionModel/delete' \
--header 'Authorization: <API密钥>' \
--header 'Content-Type: application/json' \
--data '{
"fashionModelId": <fashionModelId>
}'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功"
}
我的场景
创建我的场景
POST https://openapi.weshop.com/openapi/v1/agent/myLocation/create
传入满足要求的场景图片(image)和场景名称(name)。每个账户最多能创建1000条。
请求参数
- json格式
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
image | 是 | string | 上传的图片 | 1. 使用外部图片链接时,须确保图片链接公网可访问 2. 分辨率不得低于512*512 3. 图片的大小不超过10M 4. 图片格式:png,jpeg,jpg,webp 5. 带有模特和场景的图片 |
name | 否 | string | 场景名称 | 默认:我的场景 x |
agentName | 是 | string | 智能体名称: "aimodel" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locationId | 是 | int | 我的场景ID | / |
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myLocation/create' \
--header 'Authorization: <API密钥>' \
--header 'Content-Type: application/json' \
--data '{
"image": "https://ai-image.weshop.com/xxxxxxxx.png",
"name": "locationName",
"agentName": "aimodel",
"agentVersion" : "v1.0"
}'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功",
"data": {
"locationId": 00000000001
}
}
查询我的场景
GET https://openapi.weshop.com/openapi/v1/agent/myLocation/query
传入我的场景ID(locationId)。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
locationId | 是 | string | 我的场景ID | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locationId | 是 | int | 我的场景ID | / |
name | 是 | string | 场景名称 | / |
cover | 是 | string | 场景封面图 | / |
image | 是 | string | 上传的场景图片 | / |
status | 是 | string | 生成场景的状态 prepare:生成准备中 complete:完成 failed:生成失败 | 仅当状态为完成时,才可以使用该场景。 |
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myLocation/query?locationId=<我的场景ID>' \
--header 'Authorization: <API密钥>'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功",
"data": {
"cover": "https://ai-image.weshop.com/xxxxxxxx.png",
"locationId": 00000000001,
"image": "https://ai-image.weshop.com/xxxxxxxx.png",
"name": "locationName",
"status": "complete"
}
}
删除我的场景
POST https://openapi.weshop.com/openapi/v1/agent/myLocation/delete
传入我的场景ID(locationId),删除该场景。
请求参数
- json格式
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
locationId | 是 | int | 我的场景ID | / |
响应参数
无
curl请求示例
curl --location 'https://openapi.weshop.com/openapi/v1/agent/myLocation/delete' \
--header 'Authorization: <API密钥>' \
--header 'Content-Type: application/json' \
--data '{
"locationId": <locationId>
}'
响应示例
{
"success": true,
"code": "0",
"msg": "操作成功"
}
AI静物
轻松生成具有专业静物商业摄影效果的产品主图。
基础信息
AgentName
aiproduct
AgentVersion
- v1.0
注意事项
- 执行任务时,在textDescription、locationId这些参数中,请至少选择其中一个或者多个参数进行执行。
- 如果您想以自然语言的方式描述需要生成的图像内容,可对参数textDescription赋值。
- 若您倾向于使用智能体的预设最佳实践模板。可提供locationId参数。您可以通过智能体的info API查询到合法的locationId的值。
- 蒙板设置
- 如果您只需要更换背景,在执行任务时请将maskType设置为“autoSubjectSegment”。智能体将使用自动主体分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您需要自主选择保持不变的区域,请在操作之前准备好蒙版图,并在执行任务时将maskType设置为“custom”。在这种情况下,您须提供customMask或customMaskUrl参数。您可以使用weshop-segment sdk (opens in a new tab)编辑选区来生成蒙版图,或者使用其他工具生成所需的蒙版图。
任务
创建任务
请求参数
- initParams
参数样例:
{
"initParams": {
"taskName": "Create Task Api Test",
"originalImage": "https://ai-image.weshop.com/xxxxxxxx.png"
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 否 | string | 任务名称 | 不可超过20个字符 |
originalImage | 是 | string | 待处理的图片上传 | 使用外部图片链接时,须确保图片链接公网可访问 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskId | 是 | string | 任务ID 唯一标识 | / |
执行任务
请求参数
- params
参数样例:
// 自动主体分割
{
"params": {
"generatedContent": "referToOrigin",
"maskType": "autoSubjectSegment",
"locationId": 2002718,
"textDescription": "玩具赛车放在白墙前面。",
"negTextDescription": "人脸",
}
}
// 上传自定义mask
{
"params": {
"generatedContent": "freeCreation",
"maskType": "custom",
"customMask": "<蒙版图base64编码>",
"textDescription": "玩具赛车放在白墙前面。",
"negTextDescription": "人脸",
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
generatedContent | 是 | string | 选择算法倾向: "freeCreation":自由发挥 "referToOrigin":参考原图 | 1. freeCreation自由发挥会使结果图更加自由化,不受上传原图风格的约束 2. referToOrigin参考原图会使结果图的在生成过程中参考上传原图的风格 |
maskType | 是 | string | 选择mask类型: "autoSubjectSegment":自动主体分割 "custom":手动上传mask信息 | 1. autoSubjectSegment自动主体分割为主体背景分割,与网页版的换背景一致 2. 手动上传需要确保上传的蒙版图与原图尺寸相同 |
customMask | 否 | string | 上传蒙版图的base64编码 | 1. 当Mask类型为"custom"时,必须上传该参数,否则无需上传 2. 图片除蒙版区域外为透明 3. 使用base64编码,不包含前缀"data:image/png;base64" 4. 需与原图尺寸相同 |
customMaskUrl | 否 | string | 上传蒙版图的链接 | 使用外部图片链接时,须确保图片链接公网可访问,对图片的格式要求与customMask一致 |
locationId | 否 | int | 场景 | 选填 |
locationTagIds | 否 | array[int] | 场景标签 | 选填,详情参考Locations |
textDescription | 否 | string | 文字描述的内容 | 选填 |
negTextDescription | 否 | string | 不想出现的内容 | 选填 |
resultImageFormat | 否 | string | 选择生成结果图片的格式,可选项: "jpg" "png" | 默认为png |
resizeToOriginalImage | 否 | bool | 是否将生成结果图片缩放至原图的尺寸 | 默认为false |
batchCount | 否 | int | 设置本次执行生成图片的数量,最小为1,最大为16 | 默认为4,超出范围取默认值 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID 唯一标识 | / |
查询任务
请求参数
- json格式,参数样例
{
"executionId":"<execution id>"
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 否 | string | 任务执行ID | / |
taskId | 否 | string | 任务ID | 如果传入taskId参数,最多返回近20条执行信息 |
响应参数
- initParams
当前任务的初始信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 是 | string | 任务名称 | / |
originalImage | 是 | string | 任务原图链接 | / |
- execution
执行信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID | / |
status | 是 | string | 任务执行状态: Segmenting:自动分割中 Pending:排队中 Running :进行中 Success:已完成 | / |
params | 是 | object | 执行任务相关参数 | / |
executionTime | 是 | string | 任务执行时间点 | / |
results | 是 | array[object] | 任务执行结果信息 | / |
- result
执行结果
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
status | 是 | string | 执行结果枚举值 Running :执行中 Success:执行成功 Failed:执行失败 Pending:等待中 | / |
image | 是 | string | 生成的最终图片 | / |
progress | 否 | string | 处理进度,如:0.71,表示已处理71% | / |
error | 否 | string | 处理失败的信息 | 当status为Failed时,一定会返回 |
信息查询
查询智能体相关信息 传入智能体名称(agentName)和版本号(agentVersion),获得相应的配置参数信息。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
agentName | 是 | string | 智能体名称: "aiproduct" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locations | 是 | array[object] | 场景相关参数信息 | 1. 可通过智能体信息查询接口获取完整Locations信息 2. 数据结构请查看Locations |
agentVersion | 是 | string | 智能体版本 | / |
Locations
- location数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 场景Id | / |
image | 是 | string | 场景展示图片 | / |
name | 是 | string | 场景名称 | / |
categories | 是 | array[string] | 场景所在类目 | / |
tags | 否 | array[object] | 场景标签 | / |
- tag数据结构
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 场景标签Id(locationTagIds) | / |
name | 是 | string | 场景标签名称 | / |
[
{
"id": 2002681,
"image": "https://ai-image.weshop.com/fda70403-4bbf-4fa3-a34a-ce2fe881b4a5_1024x1024.png",
"name": "北极冰川",
"categories": ["自然实景"],
},
{
"id": 2002680,
"image": "https://ai-image.weshop.com/73ff6b24-c367-49e1-b62e-889c1dc947c3_1024x1024.png",
"name": "森林窗景",
"categories": ["自然实景"],
},
......
{
"id": 2002716,
"image": "https://ai-image.weshop.com/df6e002c-32cf-4630-bc27-5af5487e53d8_800x800.png",
"name": "宜家风",
"categories": ["家居风格"],
}
]
人台图【旧版】
免除了对真人模特的依赖。用户只需将服装穿到人台上,智能体就能用符合品牌调性的各类型真人模特展示服装。
基础信息
AgentName
mannequin
AgentVersion
- v1.5
- v1.0
注意事项
- 通常,更高版本的智能体具备更加出色的功能和性能。
- 如果您想以自然语言的方式描述需要生成的图像内容,请在执行任务时将参数类型(paramType)设置为“textDescription”。
- 若您倾向于使用人台图智能体的预设最佳实践模板,请在执行任务时将参数类型(paramType)设置为”template“。在此情况下,您必须提供locationId和 fashionModelId参数,而tagIds参数则为可选项。您可以通过智能体的info API查询到合法的locationId、fashionModelId和tagIds的值。
- 如果您希望使用高级指令来执行任务,请将参数类型(paramType)设置为“prompt”。在这种模式下,您需要填写posPrompt、negPrompt以及denoiseType参数。
- 蒙板设置
- 如果您只需要更换背景,而不进行模特更换,在执行任务时请将maskType设置为“autoSubjectSegment”。智能体将使用自动主体分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您需要自主选择保持不变的区域,请在操作之前准备好蒙版图,并在执行任务时将maskType设置为“custom”。在这种情况下,您须提供customMask或customMaskUrl参数。您可以使用weshop-segment sdk (opens in a new tab)编辑选区来生成蒙版图,或者使用其他工具生成所需的蒙版图。
任务
创建任务
请求参数
- initParams
参数样例:
{
"initParams": {
"taskName": "Create Task Api Test",
"originalImage": "https://ai-image.weshop.com/xxxxxxxx.png"
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 否 | string | 任务名称 | 不可超过20个字符 |
originalImage | 是 | string | 待处理的图片上传 | 使用外部图片链接时,须确保图片链接公网可访问 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskId | 是 | string | 任务ID 唯一标识 | / |
执行任务
请求参数
- params
参数样例:
// v1.5版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":286,
"fashionModelId": 88,
"tagIds": [43,55]
}
}
// v1.0版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":4,
"fashionModelId": 5,
"tagIds": [6,12,38]
}
}
// v1.5与v1.0版本通用,文字描述,上传自定义mask
{
"params": {
"paramType": "textDescription",
"maskType": "custom",
"customMask": "<蒙版图base64编码>",
"textDescription": "一位年轻的中国女性,高度细致的皮肤,逼真的细节眼睛,自然的皮肤纹理,自信的表 情,站在街头,晴天,阳光,明亮,夏日午后,清晰对焦,高品质,iPhone拍摄,超逼真。"
}
}
// v1.5与v1.0版本通用,快捷模板,自动主体分割
{
"params": {
"paramType": "prompt",
"maskType": "autoSubjectSegment",
"posPrompt": "A beautiful girl ,wearing Hanging neck vest,sleeveless,Carrying a shoulder bag,Smoked Makeup,outdoors, bright light blue sky",
"negPrompt": "bad proportions, nude, big head, no neck, extra legs, uncoordinated limbs, weird feet, weird toes, no legs, no feet",
"denoiseType": 14
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
paramType | 是 | string | 参数类型 "textDescription":文字描述 "template":快捷模版 "prompt":高级自定义 | / |
maskType | 是 | string | 选择mask类型: "autoSubjectSegment":自动主体分割 "custom":手动上传mask信息 | 1. autoSubjectSegment自动主体分割为主体背景分割,与网页版的手动选取不同 2. 手动上传需要确保上传的蒙版图与原图尺寸相同 |
customMask | 否 | string | 上传蒙版图的base64编码 | 1. 当Mask类型为"custom"时,必须上传该参数,否则无需上传 2. 图片除蒙版区域外为透明 3. 使用base64编码,不包含前缀"data:image/png;base64" 4. 需与原图尺寸相同 |
customMaskUrl | 否 | string | 上传蒙版图的链接 | 使用外部图片链接时,须确保图片链接公网可访问,对图片的格式要求与customMask一致 |
locationId | 否 | int | 生成地点 | paramType为“template”时,必填。其他不填 |
fashionModelId | 否 | int | 面具 | paramType为“template”时,必填。其他不填 |
tagIds | 否 | array[int] | 生成标签 | paramType为“template”时,选填。其他不填 |
textDescription | 否 | string | 文字描述的内容 | paramType为“textDescription”时,必填。其他不填 |
posPrompt | 否 | string | 正向提示词 | paramType为“prompt”时,必填。其他不填 |
negPrompt | 否 | string | 反向提示词 | paramType为“prompt”时,必填。其他不填 |
denoiseType | 否 | int | 可选项: 14:自由发挥 15:参考原图 | paramType为“prompt”时,必填。其他不填 |
resultImageFormat | 否 | string | 选择生成结果图片的格式,可选项: "jpg" "png" | 默认为png |
resizeToOriginalImage | 否 | bool | 是否将生成结果图片缩放至原图的尺寸 | 默认为false |
batchCount | 否 | int | 设置本次执行生成图片的数量,最小为1,最大为4 | 默认为4,超出范围取默认值 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID 唯一标识 | / |
查询任务
请求参数
- json格式,参数样例
{
"executionId":"<execution id>"
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 否 | string | 任务执行ID | / |
taskId | 否 | string | 任务ID | 如果传入taskId参数,最多返回近20条执行信息 |
响应参数
- initParams
当前任务的初始信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 是 | string | 任务名称 | / |
originalImage | 是 | string | 任务原图链接 | / |
- execution
执行信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID | / |
status | 是 | string | 任务执行状态: Segmenting:自动选择主体中 Pending:排队中 Running :进行中 Success:已完成 | / |
params | 是 | object | 执行任务相关参数 | / |
executionTime | 是 | string | 任务执行时间点 | / |
results | 是 | array[object] | 任务执行结果信息 | / |
- result
执行结果
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
status | 是 | string | 执行结果枚举值 Running :执行中 Success:执行成功 Failed:执行失败 Pending:等待中 | / |
image | 是 | string | 生成的最终图片 | / |
progress | 否 | string | 处理进度,如:0.71,表示已处理71% | / |
error | 否 | string | 处理失败的信息 | 当status为Failed时,一定会返回 |
信息查询
查询智能体相关信息 传入智能体名称(agentName)和版本号(agentVersion),获得相应的配置参数信息。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
agentName | 是 | string | 智能体名称: "mannequin" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" "v1.5" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locations | 是 | array[object] | 生成地点相关参数信息 | 1. 请求智能体信息查询接口或者查看Locations展示获取该智能体的地点信息 2. 数据结构请查看Locations |
fashionModels | 是 | array[object] | 面具相关信息参数 | 1. 请求智能体信息查询接口或者查看FashionModels展示获取该智能体的面具信息 2. 数据结构请查看FashionModels |
tags | 是 | array[object] | 生成标签相关参数信息 | 1. 请求智能体信息查询接口或者查看Tags展示获取该智能体的标签信息 2. 数据结构请查看Tags |
agentVersion | 是 | string | 智能体版本 | / |
Locations
- location数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 地点Id | / |
image | 是 | string | 地点展示图片 | / |
name | 是 | string | 地点名称 | / |
v1.5
[
{
"id": 218,
"image": "https://ai-image.weshop.com/39c93692-d711-4a42-8f64-f91dc26ef6f6.png_256x256.jpeg",
"name": "海边"
},
{
"id": 219,
"image": "https://ai-image.weshop.com/7abd3dbb-5c39-47b8-85b9-9477e09425c6.png_256x256.jpeg",
"name": "街拍"
},
{
"id": 220,
"image": "https://ai-image.weshop.com/6620dde8-1c1e-4ae2-8ed8-d333fda84d9c.png_256x256.jpeg",
"name": "大学校园"
},
{
"id": 221,
"image": "https://ai-image.weshop.com/70cc9dc4-174a-4dd8-b8dd-3f967420a58f.png_256x256.jpeg",
"name": "人文建筑景点"
},
{
"id": 222,
"image": "https://ai-image.weshop.com/f7b5b633-68c5-48b4-80f4-42636467a46a.png_256x256.jpeg",
"name": "公园"
},
{
"id": 223,
"image": "https://ai-image.weshop.com/2fcb0c93-7713-4969-b9cd-2825c58845ab.png_256x256.jpeg",
"name": "乡村"
},
{
"id": 224,
"image": "https://ai-image.weshop.com/f49a9142-0116-45c5-ac17-87916da56bfb.png_256x256.jpeg",
"name": "郊外"
},
{
"id": 225,
"image": "https://ai-image.weshop.com/75f81bd4-1cc4-40ef-8fc2-d20f5ef8e2e7.png_256x256.jpeg",
"name": "温泉"
},
{
"id": 226,
"image": "https://ai-image.weshop.com/0a766c54-6915-47ad-8cd0-c533a6d19a9c.png_256x256.jpeg",
"name": "写字楼"
},
{
"id": 227,
"image": "https://ai-image.weshop.com/a0c01e00-8907-44c7-bdc1-726e633782df.png_256x256.jpeg",
"name": "泳池"
},
{
"id": 228,
"image": "https://ai-image.weshop.com/73b4fa4d-56ea-471d-9b61-3df04a514ab3.png_256x256.jpeg",
"name": "巷子"
},
{
"id": 229,
"image": "https://ai-image.weshop.com/866425a2-c1cd-45ac-9a4b-288ab8192f66.png_256x256.jpeg",
"name": "树林"
},
{
"id": 230,
"image": "https://ai-image.weshop.com/403df960-8ac8-47c1-bdff-3e90681d855f_1024x1024.png_256x256.jpeg",
"name": "纯色摄影棚"
},
{
"id": 231,
"image": "https://ai-image.weshop.com/2bc446c7-3283-41cb-b5e2-6b2fbae36680.png_256x256.jpeg",
"name": "客厅"
},
{
"id": 232,
"image": "https://ai-image.weshop.com/7fb89f2e-6563-4079-b068-4233e14e52f3.png_256x256.jpeg",
"name": "卧室"
},
{
"id": 233,
"image": "https://ai-image.weshop.com/1c689468-c2b7-4e92-86ad-2c036edf0769.png_256x256.jpeg",
"name": "咖啡店"
},
{
"id": 234,
"image": "https://ai-image.weshop.com/e0341bc6-3849-4bf2-b4be-18ca5a314f10.png_256x256.jpeg",
"name": "健身房"
},
{
"id": 235,
"image": "https://ai-image.weshop.com/d9ea3fa1-026e-4ec3-9d6e-57cc4db8596b.png_256x256.jpeg",
"name": "厨房"
},
{
"id": 236,
"image": "https://ai-image.weshop.com/c3a9c783-529c-45a6-a454-8bfedc2b6b64.png_256x256.jpeg",
"name": "办公室"
},
{
"id": 237,
"image": "https://ai-image.weshop.com/35735fac-7f57-41fa-9e0c-1f4f4ab684db.png_256x256.jpeg",
"name": "酒吧"
},
{
"id": 238,
"image": "https://ai-image.weshop.com/66183fcb-15f8-4cac-899d-9e4c847fb5f4.png_256x256.jpeg",
"name": "图书馆"
},
{
"id": 239,
"image": "https://ai-image.weshop.com/4eca7b0c-dac6-4487-90c6-822b54415041.png_256x256.jpeg",
"name": "酒店"
},
{
"id": 240,
"image": "https://ai-image.weshop.com/6b8b7b57-4242-4faa-8fd2-7461f8664e20.png_256x256.jpeg",
"name": "购物中心"
},
{
"id": 241,
"image": "https://ai-image.weshop.com/dd5da382-4512-4562-8f10-3b23fe3e3e3a.png_256x256.jpeg",
"name": "餐厅"
},
{
"id": 272,
"image": "https://ai-image.weshop.com/31690798-48eb-49e0-ac9f-9e92c1b97fc1.png_256x256.jpeg",
"name": "花园"
},
{
"id": 292,
"image": "https://ai-image.weshop.com/fadd8893-0d8d-4fb5-911c-b9743753e4c4.png_256x256.jpeg",
"name": "室外网红地点"
},
{
"id": 293,
"image": "https://ai-image.weshop.com/85ddd02a-3bfe-4629-830d-7494a819549d.png_256x256.jpeg",
"name": "时尚拍摄"
},
{
"id": 294,
"image": "https://ai-image.weshop.com/3f755bc8-0e01-472e-b8c0-c1b32a76a869.png_256x256.jpeg",
"name": "室内网红地点"
},
{
"id": 299,
"image": "https://ai-image.weshop.com/ef520f11-b3be-4ba9-8249-969137510508.jpeg_256x256.jpeg",
"name": "T台"
},
{
"id": 300,
"image": "https://ai-image.weshop.com/6a017613-e0d1-45f2-81cd-a29be8da9a4a.jpeg_256x256.jpeg",
"name": "太空站"
},
{
"id": 301,
"image": "https://ai-image.weshop.com/2c939845-777a-4d75-8fe0-3461360e69ef.jpeg_256x256.jpeg",
"name": "超市"
},
{
"id": 302,
"image": "https://ai-image.weshop.com/dc80df67-e22d-47b5-8a23-6a6925057856.jpeg_256x256.jpeg",
"name": "海上游艇"
},
{
"id": 328,
"image": "https://ai-image.weshop.com/a4d00110-3070-49b3-980f-31a00b1738d3.png_256x256.jpeg",
"name": "小树林"
},
{
"id": 317,
"image": "https://ai-image.weshop.com/45716ed0-29b4-40aa-8f84-17d3256a3401.png_256x256.jpeg",
"name": "工业区域"
},
{
"id": 318,
"image": "https://ai-image.weshop.com/8a00c463-4cd3-41ef-99b1-3cc6d45435a8.png_256x256.jpeg",
"name": "城堡教堂"
},
{
"id": 319,
"image": "https://ai-image.weshop.com/3fee8f80-04a1-44ae-9d1d-46c766d85e63.png_256x256.jpeg",
"name": "登山徒步"
},
{
"id": 320,
"image": "https://ai-image.weshop.com/ae8774b2-54bf-441e-a38d-c709d510a60a.png_256x256.jpeg",
"name": "中式园林"
},
{
"id": 325,
"image": "https://ai-image.weshop.com/32d34587-1897-43a3-9a2b-554ad380f36c.jpeg_256x256.jpeg",
"name": "室内艺术展览"
},
{
"id": 326,
"image": "https://ai-image.weshop.com/05abc538-2219-4afa-babe-0985751c901c.jpeg_256x256.jpeg",
"name": "网红店铺门口"
},
{
"id": 327,
"image": "https://ai-image.weshop.com/8cd5d803-1405-426c-9b24-6d5f196552cd.webp_256x256.jpeg",
"name": "摩登风格杂志封面"
},
{
"id": 339,
"image": "https://ai-image.weshop.com/17b6cc30-d37c-462a-9500-50a09d361bc0.png_256x256.jpeg",
"name": "房间主题"
}
]
v1.0
[
{
"id": 2,
"image": "https://ai-image.weshop.com/39c93692-d711-4a42-8f64-f91dc26ef6f6.png_256x256.jpeg",
"name": "海边"
},
{
"id": 3,
"image": "https://ai-image.weshop.com/7abd3dbb-5c39-47b8-85b9-9477e09425c6.png_256x256.jpeg",
"name": "街拍"
},
{
"id": 4,
"image": "https://ai-image.weshop.com/6620dde8-1c1e-4ae2-8ed8-d333fda84d9c.png_256x256.jpeg",
"name": "大学校园"
},
{
"id": 5,
"image": "https://ai-image.weshop.com/70cc9dc4-174a-4dd8-b8dd-3f967420a58f.png_256x256.jpeg",
"name": "人文建筑景点"
},
{
"id": 6,
"image": "https://ai-image.weshop.com/f7b5b633-68c5-48b4-80f4-42636467a46a.png_256x256.jpeg",
"name": "公园"
},
{
"id": 7,
"image": "https://ai-image.weshop.com/2fcb0c93-7713-4969-b9cd-2825c58845ab.png_256x256.jpeg",
"name": "乡村"
},
{
"id": 8,
"image": "https://ai-image.weshop.com/f49a9142-0116-45c5-ac17-87916da56bfb.png_256x256.jpeg",
"name": "郊外"
},
{
"id": 9,
"image": "https://ai-image.weshop.com/75f81bd4-1cc4-40ef-8fc2-d20f5ef8e2e7.png_256x256.jpeg",
"name": "温泉"
},
{
"id": 10,
"image": "https://ai-image.weshop.com/0a766c54-6915-47ad-8cd0-c533a6d19a9c.png_256x256.jpeg",
"name": "写字楼"
},
{
"id": 11,
"image": "https://ai-image.weshop.com/a0c01e00-8907-44c7-bdc1-726e633782df.png_256x256.jpeg",
"name": "泳池"
},
{
"id": 12,
"image": "https://ai-image.weshop.com/73b4fa4d-56ea-471d-9b61-3df04a514ab3.png_256x256.jpeg",
"name": "巷子"
},
{
"id": 13,
"image": "https://ai-image.weshop.com/866425a2-c1cd-45ac-9a4b-288ab8192f66.png_256x256.jpeg",
"name": "树林"
},
{
"id": 14,
"image": "https://ai-image.weshop.com/8dfc9e33-c8cc-4714-aaa0-ebe0bed9cc6d.png_256x256.jpeg",
"name": "纯色摄影棚"
},
{
"id": 15,
"image": "https://ai-image.weshop.com/2bc446c7-3283-41cb-b5e2-6b2fbae36680.png_256x256.jpeg",
"name": "客厅"
},
{
"id": 16,
"image": "https://ai-image.weshop.com/7fb89f2e-6563-4079-b068-4233e14e52f3.png_256x256.jpeg",
"name": "卧室"
},
{
"id": 17,
"image": "https://ai-image.weshop.com/1c689468-c2b7-4e92-86ad-2c036edf0769.png_256x256.jpeg",
"name": "咖啡店"
},
{
"id": 18,
"image": "https://ai-image.weshop.com/e0341bc6-3849-4bf2-b4be-18ca5a314f10.png_256x256.jpeg",
"name": "健身房"
},
{
"id": 19,
"image": "https://ai-image.weshop.com/d9ea3fa1-026e-4ec3-9d6e-57cc4db8596b.png_256x256.jpeg",
"name": "厨房"
},
{
"id": 20,
"image": "https://ai-image.weshop.com/c3a9c783-529c-45a6-a454-8bfedc2b6b64.png_256x256.jpeg",
"name": "办公室"
},
{
"id": 21,
"image": "https://ai-image.weshop.com/35735fac-7f57-41fa-9e0c-1f4f4ab684db.png_256x256.jpeg",
"name": "酒吧"
},
{
"id": 22,
"image": "https://ai-image.weshop.com/66183fcb-15f8-4cac-899d-9e4c847fb5f4.png_256x256.jpeg",
"name": "图书馆"
},
{
"id": 23,
"image": "https://ai-image.weshop.com/4eca7b0c-dac6-4487-90c6-822b54415041.png_256x256.jpeg",
"name": "酒店"
},
{
"id": 24,
"image": "https://ai-image.weshop.com/6b8b7b57-4242-4faa-8fd2-7461f8664e20.png_256x256.jpeg",
"name": "购物中心"
},
{
"id": 25,
"image": "https://ai-image.weshop.com/dd5da382-4512-4562-8f10-3b23fe3e3e3a.png_256x256.jpeg",
"name": "餐厅"
},
{
"id": 98,
"image": "https://ai-image.weshop.com/31690798-48eb-49e0-ac9f-9e92c1b97fc1.png_256x256.jpeg",
"name": "花园"
},
{
"id": 123,
"image": "https://ai-image.weshop.com/6a017613-e0d1-45f2-81cd-a29be8da9a4a.jpeg_256x256.jpeg",
"name": "太空站"
},
{
"id": 129,
"image": "https://ai-image.weshop.com/dc80df67-e22d-47b5-8a23-6a6925057856.jpeg_256x256.jpeg",
"name": "海上游艇"
},
{
"id": 166,
"image": "https://ai-image.weshop.com/ef520f11-b3be-4ba9-8249-969137510508.jpeg_256x256.jpeg",
"name": "T台"
},
{
"id": 169,
"image": "https://ai-image.weshop.com/2c939845-777a-4d75-8fe0-3461360e69ef.jpeg_256x256.jpeg",
"name": "超市"
},
{
"id": 197,
"image": "https://ai-image.weshop.com/85ddd02a-3bfe-4629-830d-7494a819549d.png_256x256.jpeg",
"name": "时尚拍摄"
},
{
"id": 198,
"image": "https://ai-image.weshop.com/fadd8893-0d8d-4fb5-911c-b9743753e4c4.png_256x256.jpeg",
"name": "室外网红地点"
},
{
"id": 199,
"image": "https://ai-image.weshop.com/3f755bc8-0e01-472e-b8c0-c1b32a76a869.png_256x256.jpeg",
"name": "室内网红地点"
},
{
"id": 208,
"image": "https://ai-image.weshop.com/45716ed0-29b4-40aa-8f84-17d3256a3401.png_256x256.jpeg",
"name": "工业区域"
},
{
"id": 209,
"image": "https://ai-image.weshop.com/8a00c463-4cd3-41ef-99b1-3cc6d45435a8.png_256x256.jpeg",
"name": "城堡教堂"
},
{
"id": 210,
"image": "https://ai-image.weshop.com/3fee8f80-04a1-44ae-9d1d-46c766d85e63.png_256x256.jpeg",
"name": "登山徒步"
},
{
"id": 211,
"image": "https://ai-image.weshop.com/ae8774b2-54bf-441e-a38d-c709d510a60a.png_256x256.jpeg",
"name": "中式园林"
}
]
FashionModels
- fashionModel数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 面具Id | / |
image | 是 | string | 面具展示图片 | / |
v1.5
[
{
"id": 82,
"image": "https://ai-image.weshop.com/2e0ed02c-a340-45e4-94f7-fb673f789bd2.png_256x256.jpeg"
},
{
"id": 83,
"image": "https://ai-image.weshop.com/c9fbbc00-882e-4e62-8ed0-24ae9d9f6dcf.png_256x256.jpeg"
},
{
"id": 84,
"image": "https://ai-image.weshop.com/ea5caebe-cf0a-4afa-8682-d160271ff82e.png_256x256.jpeg"
},
{
"id": 85,
"image": "https://ai-image.weshop.com/3c0aa4b9-3e2f-46ee-b007-d389f5fc7e0e.png_256x256.jpeg"
},
{
"id": 86,
"image": "https://ai-image.weshop.com/19bcc169-61bb-41e6-9271-1db56c286633.png_256x256.jpeg"
},
{
"id": 105,
"image": "https://ai-image.weshop.com/3c68ae87-d75f-4366-a4f4-9e7b46407c37.png_256x256.jpeg"
},
{
"id": 87,
"image": "https://ai-image.weshop.com/8020f99c-48fa-46fa-93b3-c131db1af65e.png_256x256.jpeg"
},
{
"id": 88,
"image": "https://ai-image.weshop.com/38eb48ac-d88c-444f-b7e4-1aa468e86ad4.jpeg_256x256.jpeg"
},
{
"id": 106,
"image": "https://ai-image.weshop.com/3418cabe-475a-4bc8-a3d0-7934019649f7.png_256x256.jpeg"
},
{
"id": 89,
"image": "https://ai-image.weshop.com/a2c95708-6d76-40e4-96b1-516c41952a49.jpeg_256x256.jpeg"
},
{
"id": 90,
"image": "https://ai-image.weshop.com/7d103f46-1870-45b7-b964-4d87f74904af.png_256x256.jpeg"
},
{
"id": 91,
"image": "https://ai-image.weshop.com/589721bf-57e6-42d4-b5a0-1762943c2529.png_256x256.jpeg"
},
{
"id": 92,
"image": "https://ai-image.weshop.com/4314366b-7fe5-411f-b1aa-242afe676d8b.png_256x256.jpeg"
},
{
"id": 93,
"image": "https://ai-image.weshop.com/05713c25-1d1a-4843-9480-5d8f8c982ecc.png_256x256.jpeg"
},
{
"id": 94,
"image": "https://ai-image.weshop.com/39bf919c-41a2-421c-9aff-3a5ecd1fa284.png_256x256.jpeg"
},
{
"id": 95,
"image": "https://ai-image.weshop.com/1988e7a1-9e09-49a8-aec8-d5578a2ca2c3.png_256x256.jpeg"
},
{
"id": 96,
"image": "https://ai-image.weshop.com/4ba7ccb2-5a4d-4ae4-afd7-076a2a5740c1.png_256x256.jpeg"
},
{
"id": 97,
"image": "https://ai-image.weshop.com/8bca8bc2-23ec-4ac7-9a1c-f55d591621da.jpeg_256x256.jpeg"
},
{
"id": 98,
"image": "https://ai-image.weshop.com/0056c61d-92fe-460c-b88d-934dc59999fc.png_256x256.jpeg"
},
{
"id": 99,
"image": "https://ai-image.weshop.com/db896663-7d43-45a7-a039-4972829136a1.jpeg_256x256.jpeg"
},
{
"id": 100,
"image": "https://ai-image.weshop.com/70af05fd-521f-4ea0-8d76-449623689b05.jpeg_256x256.jpeg"
},
{
"id": 101,
"image": "https://ai-image.weshop.com/e49c8891-04d6-47b6-9c6a-e382cd5f2114.jpeg_256x256.jpeg"
},
{
"id": 102,
"image": "https://ai-image.weshop.com/6db47550-d298-4638-978c-b50f285df9c2.jpeg_256x256.jpeg"
}
]
v1.0
[
{
"id": 1,
"image": "https://ai-image.weshop.com/2e0ed02c-a340-45e4-94f7-fb673f789bd2.png_256x256.jpeg"
},
{
"id": 2,
"image": "https://ai-image.weshop.com/c9fbbc00-882e-4e62-8ed0-24ae9d9f6dcf.png_256x256.jpeg"
},
{
"id": 3,
"image": "https://ai-image.weshop.com/ea5caebe-cf0a-4afa-8682-d160271ff82e.png_256x256.jpeg"
},
{
"id": 4,
"image": "https://ai-image.weshop.com/3c0aa4b9-3e2f-46ee-b007-d389f5fc7e0e.png_256x256.jpeg"
},
{
"id": 5,
"image": "https://ai-image.weshop.com/19bcc169-61bb-41e6-9271-1db56c286633.png_256x256.jpeg"
},
{
"id": 6,
"image": "https://ai-image.weshop.com/8020f99c-48fa-46fa-93b3-c131db1af65e.png_256x256.jpeg"
},
{
"id": 7,
"image": "https://ai-image.weshop.com/38eb48ac-d88c-444f-b7e4-1aa468e86ad4.jpeg_256x256.jpeg"
},
{
"id": 8,
"image": "https://ai-image.weshop.com/a2c95708-6d76-40e4-96b1-516c41952a49.jpeg_256x256.jpeg"
},
{
"id": 9,
"image": "https://ai-image.weshop.com/7d103f46-1870-45b7-b964-4d87f74904af.png_256x256.jpeg"
},
{
"id": 10,
"image": "https://ai-image.weshop.com/589721bf-57e6-42d4-b5a0-1762943c2529.png_256x256.jpeg"
},
{
"id": 11,
"image": "https://ai-image.weshop.com/4314366b-7fe5-411f-b1aa-242afe676d8b.png_256x256.jpeg"
},
{
"id": 12,
"image": "https://ai-image.weshop.com/05713c25-1d1a-4843-9480-5d8f8c982ecc.png_256x256.jpeg"
},
{
"id": 13,
"image": "https://ai-image.weshop.com/39bf919c-41a2-421c-9aff-3a5ecd1fa284.png_256x256.jpeg"
},
{
"id": 14,
"image": "https://ai-image.weshop.com/1988e7a1-9e09-49a8-aec8-d5578a2ca2c3.png_256x256.jpeg"
},
{
"id": 15,
"image": "https://ai-image.weshop.com/4ba7ccb2-5a4d-4ae4-afd7-076a2a5740c1.png_256x256.jpeg"
},
{
"id": 16,
"image": "https://ai-image.weshop.com/0056c61d-92fe-460c-b88d-934dc59999fc.png_256x256.jpeg"
},
{
"id": 17,
"image": "https://ai-image.weshop.com/db896663-7d43-45a7-a039-4972829136a1.jpeg_256x256.jpeg"
},
{
"id": 74,
"image": "https://ai-image.weshop.com/e49c8891-04d6-47b6-9c6a-e382cd5f2114.jpeg_256x256.jpeg"
},
{
"id": 75,
"image": "https://ai-image.weshop.com/70af05fd-521f-4ea0-8d76-449623689b05.jpeg_256x256.jpeg"
},
{
"id": 76,
"image": "https://ai-image.weshop.com/6db47550-d298-4638-978c-b50f285df9c2.jpeg_256x256.jpeg"
},
{
"id": 79,
"image": "https://ai-image.weshop.com/b2490472-735f-488b-b2ca-8a13cd3fcbaa.jpeg_256x256.jpeg"
},
{
"id": 80,
"image": "https://ai-image.weshop.com/2ed050e8-b005-4ddf-9f9c-02865b5a37a2.jpeg_256x256.jpeg"
},
{
"id": 81,
"image": "https://ai-image.weshop.com/8bca8bc2-23ec-4ac7-9a1c-f55d591621da.jpeg_256x256.jpeg"
}
]
Tags
- tags数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 生成标签Id | / |
name | 是 | string | 生成标签名称 | / |
v1.5
[
{
"id": 44,
"name": "大笑"
},
{
"id": 52,
"name": "微笑"
},
{
"id": 45,
"name": "时尚高冷"
},
{
"id": 43,
"name": "气质"
},
{
"id": 55,
"name": "优雅"
},
{
"id": 42,
"name": "单纯"
},
{
"id": 46,
"name": "婴儿"
},
{
"id": 57,
"name": "儿童"
},
{
"id": 56,
"name": "大童"
},
{
"id": 53,
"name": "少年"
},
{
"id": 47,
"name": "青年"
},
{
"id": 54,
"name": "中年"
},
{
"id": 48,
"name": "老年"
},
{
"id": 49,
"name": "背面"
},
{
"id": 58,
"name": "春天"
},
{
"id": 50,
"name": "夏天"
},
{
"id": 59,
"name": "秋天"
},
{
"id": 51,
"name": "冬天"
}
]
v1.0
[
{
"id": 1,
"name": "大笑"
},
{
"id": 2,
"name": "微笑"
},
{
"id": 3,
"name": "时尚高冷"
},
{
"id": 4,
"name": "气质"
},
{
"id": 5,
"name": "优雅"
},
{
"id": 6,
"name": "单纯"
},
{
"id": 7,
"name": "婴儿"
},
{
"id": 8,
"name": "儿童"
},
{
"id": 9,
"name": "大童"
},
{
"id": 10,
"name": "少年"
},
{
"id": 11,
"name": "青年"
},
{
"id": 12,
"name": "中年"
},
{
"id": 13,
"name": "老年"
},
{
"id": 37,
"name": "背面"
},
{
"id": 38,
"name": "春天"
},
{
"id": 39,
"name": "夏天"
},
{
"id": 40,
"name": "秋天"
},
{
"id": 41,
"name": "冬天"
}
]
真人图【旧版】
打破了拍摄地点和模特类型的限制。提供任意真人图片,真人图智能体即可切换适合世界各地市场的拍摄场景和模特类型。
基础信息
AgentName
model
AgentVersion
- v1.5
- v1.0
注意事项
- 通常,更高版本的智能体具备更加出色的功能和性能。
- 如果您想以自然语言的方式描述需要生成的图像内容,请在执行任务时将参数类型(paramType)设置为“textDescription”。
- 若您倾向于使用人台图智能体的预设最佳实践模板,请在执行任务时将参数类型(paramType)设置为”template“。在此情况下,您必须提供locationId和 fashionModelId参数,而tagIds参数则为可选项。您可以通过智能体的info API查询到合法的locationId、fashionModelId和tagIds的值,不同版本之间不能混用。
- 如果您希望使用高级指令来执行任务,请将参数类型(paramType)设置为“prompt”。在这种模式下,您需要填写posPrompt、negPrompt以及denoiseType参数。
- 蒙板设置
- 如果您只需要更换背景,而不进行模特更换,在执行任务时请将maskType设置为“autoSubjectSegment”。智能体将使用自动主体分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您需要自主选择保持不变的区域,请在操作之前准备好蒙版图,并在执行任务时将maskType设置为“custom”。在这种情况下,您须提供customMask或customMaskUrl参数。您可以使用weshop-segment sdk (opens in a new tab)编辑选区来生成蒙版图,或者使用其他工具生成所需的蒙版图。
任务
创建任务
请求参数
- initParams
参数样例:
{
"initParams": {
"taskName": "Create Task Api Test",
"originalImage": "https://ai-image.weshop.com/xxxxxxxx.png"
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 否 | string | 任务名称 | 不可超过20个字符 |
originalImage | 是 | string | 待处理的图片上传 | 使用外部图片链接时,须确保外部图片链接公网可访问 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskId | 是 | string | 任务ID 唯一标识 | / |
执行任务
请求参数
- params
参数样例:
// v1.5版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":417,
"fashionModelId": 113,
"tagIds": [45,43]
}
}
// v1.0版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":26,
"fashionModelId": 1,
"tagIds": [6,12,38]
}
}
// v1.5与v1.0版本通用,文字描述,上传自定义mask
{
"params": {
"paramType": "textDescription",
"maskType": "custom",
"customMask": "<蒙版图base64编码>",
"textDescription": "一位年轻的中国女性,高度细致的皮肤,逼真的细节眼睛,自然的皮肤纹理,自信的表 情,站在街头,晴天,阳光,明亮,夏日午后,清晰对焦,高品质,iPhone拍摄,超逼真。"
}
}
// v1.5与v1.0版本通用,快捷模板,自动主体分割
{
"params": {
"paramType": "prompt",
"maskType": "autoSubjectSegment",
"posPrompt": "A beautiful girl ,wearing Hanging neck vest,sleeveless,Carrying a shoulder bag,Smoked Makeup,outdoors, bright light blue sky",
"negPrompt": "bad proportions, nude, big head, no neck, extra legs, uncoordinated limbs, weird feet, weird toes, no legs, no feet",
"denoiseType": 14
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
paramType | 是 | string | 参数类型 "textDescription":文字描述 "template":快捷模版 "prompt":高级自定义 | / |
maskType | 是 | string | 选择mask类型: "autoSubjectSegment":自动主体分割 "custom":手动上传mask信息 | 1. autoSubjectSegment自动主体分割为主体背景分割,与网页版的手动选取不同 2. 手动上传需要确保上传的Mask图与原图尺寸相同 |
customMask | 否 | string | 上传蒙版图的base64编码 | 1. 当Mask类型为"custom"时,必须上传该参数,否则无需上传 2. 图片除蒙版区域外为透明 3. 使用base64编码,不包含前缀"data:image/png;base64" |
customMaskUrl | 否 | string | 上传蒙版图的链接 | 使用外部图片链接时,须确保图片链接公网可访问,对图片的格式要求与customMask一致 |
locationId | 否 | int | 生成地点 | paramType为“template”时,必填。其他不填 |
fashionModelId | 否 | int | 面具 | paramType为“template”时,必填。其他不填 |
tagIds | 否 | array[int] | 生成标签 | paramType为“template”时,选填。其他不填 |
textDescription | 否 | string | 文字描述的内容 | paramType为“textDescription”时,必填。其他不填 |
posPrompt | 否 | string | 正向提示词 | paramType为“prompt”时,必填。其他不填 |
negPrompt | 否 | string | 反向提示词 | paramType为“prompt”时,必填。其他不填 |
denoiseType | 否 | int | 可选项: 14:自由发挥 15:参考原图 | paramType为“prompt”时,必填。其他不填 |
resultImageFormat | 否 | string | 选择生成结果图片的格式,可选项: "jpg" "png" | 默认为png |
resizeToOriginalImage | 否 | bool | 是否将生成结果图片缩放至原图的尺寸 | 默认为false |
batchCount | 否 | int | 设置本次执行生成图片的数量,最小为1,最大为4 | 默认为4,超出范围取默认值 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID 唯一标识 | / |
查询任务
请求参数
- 参数样例,json格式
{
"executionId":"<execution id>"
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 否 | string | 任务执行ID | / |
taskId | 否 | string | 任务ID | 如果传入taskId参数,最多返回近20条执行信息 |
响应参数
- initParams
当前任务的初始信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 是 | string | 任务名称 | / |
originalImage | 是 | string | 任务原图 | / |
- execution
执行信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID | / |
status | 是 | string | 任务执行状态: Segmenting:自动选择主体中 Pending:排队中 Running :进行中 Success:已完成 | / |
params | 是 | object | 执行任务相关参数 | / |
executionTime | 是 | string | 任务执行时间点 | / |
results | 是 | array[object] | 任务执行结果信息 | / |
- result
执行结果
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
status | 是 | string | 执行结果枚举值 Running :执行中 Success:执行成功 Failed:执行失败 Pending:等待中 | / |
image | 是 | string | 生成的最终图片 | / |
progress | 否 | string | 处理进度,如:0.71,表示已处理71% | / |
error | 否 | string | 处理失败的信息 | 当status为Failed时,一定会返回 |
信息查询
传入智能体名称(agentName)和版本号(agentVersion),获得智能体配置参数信息。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
agentName | 是 | string | 智能体名称: "model" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" "v1.5" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locations | 是 | array[object] | 生成地点相关参数信息 | 1. 请求智能体信息查询接口或者查看Locations展示获取该智能体的地点信息 2. 数据结构请查看Locations |
fashionModels | 是 | array[object] | 面具相关信息参数 | 1. 请求智能体信息查询接口或者查看FashionModels展示获取该智能体的面具信息 2. 数据结构请查看FashionModels |
tags | 是 | array[object] | 生成标签相关参数信息 | 1. 请求智能体信息查询接口或者查看Tags展示获取该智能体的标签信息 2. 数据结构请查看Tags |
agentVersion | 是 | string | 智能体版本 | / |
Locations
- locations数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 地点Id | / |
image | 是 | string | 地点展示图片 | / |
name | 是 | string | 地点名称 | / |
v1.5
[
{
"id": 242,
"image": "https://ai-image.weshop.com/39c93692-d711-4a42-8f64-f91dc26ef6f6.png_256x256.jpeg",
"name": "海边"
},
{
"id": 243,
"image": "https://ai-image.weshop.com/7abd3dbb-5c39-47b8-85b9-9477e09425c6.png_256x256.jpeg",
"name": "街拍"
},
{
"id": 329,
"image": "https://ai-image.weshop.com/8609c2df-69a0-4110-bdd8-7f7cc795bec0_1024x1024.png_256x256.jpeg",
"name": "街头艺术"
},
{
"id": 244,
"image": "https://ai-image.weshop.com/6620dde8-1c1e-4ae2-8ed8-d333fda84d9c.png_256x256.jpeg",
"name": "大学校园"
},
{
"id": 245,
"image": "https://ai-image.weshop.com/70cc9dc4-174a-4dd8-b8dd-3f967420a58f.png_256x256.jpeg",
"name": "人文建筑景点"
},
{
"id": 246,
"image": "https://ai-image.weshop.com/f7b5b633-68c5-48b4-80f4-42636467a46a.png_256x256.jpeg",
"name": "公园"
},
{
"id": 247,
"image": "https://ai-image.weshop.com/2fcb0c93-7713-4969-b9cd-2825c58845ab.png_256x256.jpeg",
"name": "乡村"
},
{
"id": 248,
"image": "https://ai-image.weshop.com/f49a9142-0116-45c5-ac17-87916da56bfb.png_256x256.jpeg",
"name": "郊外"
},
{
"id": 249,
"image": "https://ai-image.weshop.com/75f81bd4-1cc4-40ef-8fc2-d20f5ef8e2e7.png_256x256.jpeg",
"name": "温泉"
},
{
"id": 250,
"image": "https://ai-image.weshop.com/0a766c54-6915-47ad-8cd0-c533a6d19a9c.png_256x256.jpeg",
"name": "写字楼"
},
{
"id": 251,
"image": "https://ai-image.weshop.com/a0c01e00-8907-44c7-bdc1-726e633782df.png_256x256.jpeg",
"name": "泳池"
},
{
"id": 216,
"image": "https://ai-image.weshop.com/73b4fa4d-56ea-471d-9b61-3df04a514ab3.png_256x256.jpeg",
"name": "巷子"
},
{
"id": 252,
"image": "https://ai-image.weshop.com/866425a2-c1cd-45ac-9a4b-288ab8192f66.png_256x256.jpeg",
"name": "树林"
},
{
"id": 253,
"image": "https://ai-image.weshop.com/403df960-8ac8-47c1-bdff-3e90681d855f_1024x1024.png_256x256.jpeg",
"name": "纯色摄影棚"
},
{
"id": 254,
"image": "https://ai-image.weshop.com/2bc446c7-3283-41cb-b5e2-6b2fbae36680.png_256x256.jpeg",
"name": "客厅"
},
{
"id": 255,
"image": "https://ai-image.weshop.com/7fb89f2e-6563-4079-b068-4233e14e52f3.png_256x256.jpeg",
"name": "卧室"
},
{
"id": 256,
"image": "https://ai-image.weshop.com/1c689468-c2b7-4e92-86ad-2c036edf0769.png_256x256.jpeg",
"name": "咖啡店"
},
{
"id": 257,
"image": "https://ai-image.weshop.com/e0341bc6-3849-4bf2-b4be-18ca5a314f10.png_256x256.jpeg",
"name": "健身房"
},
{
"id": 258,
"image": "https://ai-image.weshop.com/d9ea3fa1-026e-4ec3-9d6e-57cc4db8596b.png_256x256.jpeg",
"name": "厨房"
},
{
"id": 259,
"image": "https://ai-image.weshop.com/c3a9c783-529c-45a6-a454-8bfedc2b6b64.png_256x256.jpeg",
"name": "办公室"
},
{
"id": 260,
"image": "https://ai-image.weshop.com/35735fac-7f57-41fa-9e0c-1f4f4ab684db.png_256x256.jpeg",
"name": "酒吧"
},
{
"id": 261,
"image": "https://ai-image.weshop.com/66183fcb-15f8-4cac-899d-9e4c847fb5f4.png_256x256.jpeg",
"name": "图书馆"
},
{
"id": 262,
"image": "https://ai-image.weshop.com/4eca7b0c-dac6-4487-90c6-822b54415041.png_256x256.jpeg",
"name": "酒店"
},
{
"id": 263,
"image": "https://ai-image.weshop.com/6b8b7b57-4242-4faa-8fd2-7461f8664e20.png_256x256.jpeg",
"name": "购物中心"
},
{
"id": 264,
"image": "https://ai-image.weshop.com/dd5da382-4512-4562-8f10-3b23fe3e3e3a.png_256x256.jpeg",
"name": "餐厅"
},
{
"id": 323,
"image": "https://ai-image.weshop.com/31690798-48eb-49e0-ac9f-9e92c1b97fc1.png_256x256.jpeg",
"name": "花园"
},
{
"id": 289,
"image": "https://ai-image.weshop.com/fadd8893-0d8d-4fb5-911c-b9743753e4c4.png_256x256.jpeg",
"name": "室外网红地点"
},
{
"id": 290,
"image": "https://ai-image.weshop.com/3f755bc8-0e01-472e-b8c0-c1b32a76a869.png_256x256.jpeg",
"name": "室内网红地点"
},
{
"id": 291,
"image": "https://ai-image.weshop.com/85ddd02a-3bfe-4629-830d-7494a819549d.png_256x256.jpeg",
"name": "时尚拍摄"
},
{
"id": 295,
"image": "https://ai-image.weshop.com/ef520f11-b3be-4ba9-8249-969137510508.jpeg_256x256.jpeg",
"name": "T台"
},
{
"id": 296,
"image": "https://ai-image.weshop.com/6a017613-e0d1-45f2-81cd-a29be8da9a4a.jpeg_256x256.jpeg",
"name": "太空站"
},
{
"id": 297,
"image": "https://ai-image.weshop.com/2c939845-777a-4d75-8fe0-3461360e69ef.jpeg_256x256.jpeg",
"name": "超市"
},
{
"id": 298,
"image": "https://ai-image.weshop.com/dc80df67-e22d-47b5-8a23-6a6925057856.jpeg_256x256.jpeg",
"name": "海上游艇"
},
{
"id": 303,
"image": "https://ai-image.weshop.com/a4d00110-3070-49b3-980f-31a00b1738d3.png_256x256.jpeg",
"name": "小树林"
},
{
"id": 307,
"image": "https://ai-image.weshop.com/45716ed0-29b4-40aa-8f84-17d3256a3401.png_256x256.jpeg",
"name": "工业区域"
},
{
"id": 308,
"image": "https://ai-image.weshop.com/8a00c463-4cd3-41ef-99b1-3cc6d45435a8.png_256x256.jpeg",
"name": "城堡教堂"
},
{
"id": 309,
"image": "https://ai-image.weshop.com/3fee8f80-04a1-44ae-9d1d-46c766d85e63.png_256x256.jpeg",
"name": "登山徒步"
},
{
"id": 310,
"image": "https://ai-image.weshop.com/ae8774b2-54bf-441e-a38d-c709d510a60a.png_256x256.jpeg",
"name": "中式园林"
},
{
"id": 311,
"image": "https://ai-image.weshop.com/32d34587-1897-43a3-9a2b-554ad380f36c.jpeg_256x256.jpeg",
"name": "室内艺术展览"
},
{
"id": 321,
"image": "https://ai-image.weshop.com/05abc538-2219-4afa-babe-0985751c901c.jpeg_256x256.jpeg",
"name": "网红店铺门口"
},
{
"id": 324,
"image": "https://ai-image.weshop.com/8cd5d803-1405-426c-9b24-6d5f196552cd.webp_256x256.jpeg",
"name": "摩登风格杂志封面"
},
{
"id": 322,
"image": "https://ai-image.weshop.com/17b6cc30-d37c-462a-9500-50a09d361bc0.png_256x256.jpeg",
"name": "房间主题"
},
{
"id": 330,
"image": "https://ai-image.weshop.com/b5f490d6-ac97-4881-815f-4c7a970467b9_1024x1024.png_256x256.jpeg",
"name": "城市路边"
},
{
"id": 331,
"image": "https://ai-image.weshop.com/9dc969a5-fcff-4046-bc69-0e95030783b0_1024x1024.png_256x256.jpeg",
"name": "巴黎"
},
{
"id": 332,
"image": "https://ai-image.weshop.com/3a44bae5-2df6-4526-b7f1-e2c6de7c2d31_1024x1024.png_256x256.jpeg",
"name": "马路街拍"
},
{
"id": 333,
"image": "https://ai-image.weshop.com/04c21d08-74a3-45bc-914d-b54d161bd78d_1024x1024.png_256x256.jpeg",
"name": "现代公寓"
},
{
"id": 334,
"image": "https://ai-image.weshop.com/8d699232-e6f3-455d-9727-405f8f0e5895_1024x1024.png_256x256.jpeg",
"name": "英伦街"
},
{
"id": 335,
"image": "https://ai-image.weshop.com/7cf22d6b-4096-472d-a015-b28bb3e5c49e_1024x1024.png_256x256.jpeg",
"name": "度假旅拍"
},
{
"id": 336,
"image": "https://ai-image.weshop.com/8dfc9e33-c8cc-4714-aaa0-ebe0bed9cc6d.png_256x256.jpeg",
"name": "纯色干净背景"
},
{
"id": 337,
"image": "https://ai-image.weshop.com/da3c0066-8c1b-42bf-867c-49b01d545e8c_1024x1024.png_256x256.jpeg",
"name": "午后乡间小路"
},
{
"id": 338,
"image": "https://ai-image.weshop.com/efc573fe-6ed4-4428-8268-1e16f3a8789c_1024x1024.png_256x256.jpeg",
"name": "黑白格子客厅"
}
]
v1.0
[
{
"id": 26,
"image": "https://ai-image.weshop.com/39c93692-d711-4a42-8f64-f91dc26ef6f6.png_256x256.jpeg",
"name": "海边"
},
{
"id": 27,
"image": "https://ai-image.weshop.com/7abd3dbb-5c39-47b8-85b9-9477e09425c6.png_256x256.jpeg",
"name": "街拍"
},
{
"id": 28,
"image": "https://ai-image.weshop.com/6620dde8-1c1e-4ae2-8ed8-d333fda84d9c.png_256x256.jpeg",
"name": "大学校园"
},
{
"id": 29,
"image": "https://ai-image.weshop.com/70cc9dc4-174a-4dd8-b8dd-3f967420a58f.png_256x256.jpeg",
"name": "人文建筑景点"
},
{
"id": 30,
"image": "https://ai-image.weshop.com/f7b5b633-68c5-48b4-80f4-42636467a46a.png_256x256.jpeg",
"name": "公园"
},
{
"id": 31,
"image": "https://ai-image.weshop.com/2fcb0c93-7713-4969-b9cd-2825c58845ab.png_256x256.jpeg",
"name": "乡村"
},
{
"id": 32,
"image": "https://ai-image.weshop.com/f49a9142-0116-45c5-ac17-87916da56bfb.png_256x256.jpeg",
"name": "郊外"
},
{
"id": 33,
"image": "https://ai-image.weshop.com/75f81bd4-1cc4-40ef-8fc2-d20f5ef8e2e7.png_256x256.jpeg",
"name": "温泉"
},
{
"id": 34,
"image": "https://ai-image.weshop.com/0a766c54-6915-47ad-8cd0-c533a6d19a9c.png_256x256.jpeg",
"name": "写字楼"
},
{
"id": 35,
"image": "https://ai-image.weshop.com/a0c01e00-8907-44c7-bdc1-726e633782df.png_256x256.jpeg",
"name": "泳池"
},
{
"id": 36,
"image": "https://ai-image.weshop.com/73b4fa4d-56ea-471d-9b61-3df04a514ab3.png_256x256.jpeg",
"name": "巷子"
},
{
"id": 37,
"image": "https://ai-image.weshop.com/866425a2-c1cd-45ac-9a4b-288ab8192f66.png_256x256.jpeg",
"name": "树林"
},
{
"id": 38,
"image": "https://ai-image.weshop.com/8dfc9e33-c8cc-4714-aaa0-ebe0bed9cc6d.png_256x256.jpeg",
"name": "纯色摄影棚"
},
{
"id": 39,
"image": "https://ai-image.weshop.com/2bc446c7-3283-41cb-b5e2-6b2fbae36680.png_256x256.jpeg",
"name": "客厅"
},
{
"id": 40,
"image": "https://ai-image.weshop.com/7fb89f2e-6563-4079-b068-4233e14e52f3.png_256x256.jpeg",
"name": "卧室"
},
{
"id": 41,
"image": "https://ai-image.weshop.com/1c689468-c2b7-4e92-86ad-2c036edf0769.png_256x256.jpeg",
"name": "咖啡店"
},
{
"id": 42,
"image": "https://ai-image.weshop.com/e0341bc6-3849-4bf2-b4be-18ca5a314f10.png_256x256.jpeg",
"name": "健身房"
},
{
"id": 43,
"image": "https://ai-image.weshop.com/d9ea3fa1-026e-4ec3-9d6e-57cc4db8596b.png_256x256.jpeg",
"name": "厨房"
},
{
"id": 44,
"image": "https://ai-image.weshop.com/c3a9c783-529c-45a6-a454-8bfedc2b6b64.png_256x256.jpeg",
"name": "办公室"
},
{
"id": 45,
"image": "https://ai-image.weshop.com/35735fac-7f57-41fa-9e0c-1f4f4ab684db.png_256x256.jpeg",
"name": "酒吧"
},
{
"id": 46,
"image": "https://ai-image.weshop.com/66183fcb-15f8-4cac-899d-9e4c847fb5f4.png_256x256.jpeg",
"name": "图书馆"
},
{
"id": 47,
"image": "https://ai-image.weshop.com/4eca7b0c-dac6-4487-90c6-822b54415041.png_256x256.jpeg",
"name": "酒店"
},
{
"id": 48,
"image": "https://ai-image.weshop.com/6b8b7b57-4242-4faa-8fd2-7461f8664e20.png_256x256.jpeg",
"name": "购物中心"
},
{
"id": 49,
"image": "https://ai-image.weshop.com/dd5da382-4512-4562-8f10-3b23fe3e3e3a.png_256x256.jpeg",
"name": "餐厅"
},
{
"id": 99,
"image": "https://ai-image.weshop.com/31690798-48eb-49e0-ac9f-9e92c1b97fc1.png_256x256.jpeg",
"name": "花园"
},
{
"id": 126,
"image": "https://ai-image.weshop.com/6a017613-e0d1-45f2-81cd-a29be8da9a4a.jpeg_256x256.jpeg",
"name": "太空站"
},
{
"id": 128,
"image": "https://ai-image.weshop.com/dc80df67-e22d-47b5-8a23-6a6925057856.jpeg_256x256.jpeg",
"name": "海上游艇"
},
{
"id": 167,
"image": "https://ai-image.weshop.com/ef520f11-b3be-4ba9-8249-969137510508.jpeg_256x256.jpeg",
"name": "T台"
},
{
"id": 170,
"image": "https://ai-image.weshop.com/2c939845-777a-4d75-8fe0-3461360e69ef.jpeg_256x256.jpeg",
"name": "超市"
},
{
"id": 194,
"image": "https://ai-image.weshop.com/85ddd02a-3bfe-4629-830d-7494a819549d.png_256x256.jpeg",
"name": "时尚拍摄"
},
{
"id": 195,
"image": "https://ai-image.weshop.com/3f755bc8-0e01-472e-b8c0-c1b32a76a869.png_256x256.jpeg",
"name": "室内网红地点"
},
{
"id": 196,
"image": "https://ai-image.weshop.com/fadd8893-0d8d-4fb5-911c-b9743753e4c4.png_256x256.jpeg",
"name": "室外网红地点"
},
{
"id": 200,
"image": "https://ai-image.weshop.com/a4d00110-3070-49b3-980f-31a00b1738d3.png_256x256.jpeg",
"name": "小树林"
},
{
"id": 204,
"image": "https://ai-image.weshop.com/45716ed0-29b4-40aa-8f84-17d3256a3401.png_256x256.jpeg",
"name": "工业区域"
},
{
"id": 205,
"image": "https://ai-image.weshop.com/8a00c463-4cd3-41ef-99b1-3cc6d45435a8.png_256x256.jpeg",
"name": "城堡教堂"
},
{
"id": 206,
"image": "https://ai-image.weshop.com/3fee8f80-04a1-44ae-9d1d-46c766d85e63.png_256x256.jpeg",
"name": "登山徒步"
},
{
"id": 207,
"image": "https://ai-image.weshop.com/ae8774b2-54bf-441e-a38d-c709d510a60a.png_256x256.jpeg",
"name": "中式园林"
}
]
FashionModels
- fashionModel数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 面具Id | / |
image | 是 | string | 面具展示图片 | / |
v1.5
[
{
"id": 82,
"image": "https://ai-image.weshop.com/2e0ed02c-a340-45e4-94f7-fb673f789bd2.png_256x256.jpeg"
},
{
"id": 83,
"image": "https://ai-image.weshop.com/c9fbbc00-882e-4e62-8ed0-24ae9d9f6dcf.png_256x256.jpeg"
},
{
"id": 84,
"image": "https://ai-image.weshop.com/ea5caebe-cf0a-4afa-8682-d160271ff82e.png_256x256.jpeg"
},
{
"id": 85,
"image": "https://ai-image.weshop.com/3c0aa4b9-3e2f-46ee-b007-d389f5fc7e0e.png_256x256.jpeg"
},
{
"id": 86,
"image": "https://ai-image.weshop.com/19bcc169-61bb-41e6-9271-1db56c286633.png_256x256.jpeg"
},
{
"id": 105,
"image": "https://ai-image.weshop.com/3c68ae87-d75f-4366-a4f4-9e7b46407c37.png_256x256.jpeg"
},
{
"id": 87,
"image": "https://ai-image.weshop.com/8020f99c-48fa-46fa-93b3-c131db1af65e.png_256x256.jpeg"
},
{
"id": 88,
"image": "https://ai-image.weshop.com/38eb48ac-d88c-444f-b7e4-1aa468e86ad4.jpeg_256x256.jpeg"
},
{
"id": 106,
"image": "https://ai-image.weshop.com/3418cabe-475a-4bc8-a3d0-7934019649f7.png_256x256.jpeg"
},
{
"id": 89,
"image": "https://ai-image.weshop.com/a2c95708-6d76-40e4-96b1-516c41952a49.jpeg_256x256.jpeg"
},
{
"id": 90,
"image": "https://ai-image.weshop.com/7d103f46-1870-45b7-b964-4d87f74904af.png_256x256.jpeg"
},
{
"id": 91,
"image": "https://ai-image.weshop.com/589721bf-57e6-42d4-b5a0-1762943c2529.png_256x256.jpeg"
},
{
"id": 92,
"image": "https://ai-image.weshop.com/4314366b-7fe5-411f-b1aa-242afe676d8b.png_256x256.jpeg"
},
{
"id": 93,
"image": "https://ai-image.weshop.com/05713c25-1d1a-4843-9480-5d8f8c982ecc.png_256x256.jpeg"
},
{
"id": 94,
"image": "https://ai-image.weshop.com/39bf919c-41a2-421c-9aff-3a5ecd1fa284.png_256x256.jpeg"
},
{
"id": 95,
"image": "https://ai-image.weshop.com/1988e7a1-9e09-49a8-aec8-d5578a2ca2c3.png_256x256.jpeg"
},
{
"id": 96,
"image": "https://ai-image.weshop.com/4ba7ccb2-5a4d-4ae4-afd7-076a2a5740c1.png_256x256.jpeg"
},
{
"id": 97,
"image": "https://ai-image.weshop.com/8bca8bc2-23ec-4ac7-9a1c-f55d591621da.jpeg_256x256.jpeg"
},
{
"id": 98,
"image": "https://ai-image.weshop.com/0056c61d-92fe-460c-b88d-934dc59999fc.png_256x256.jpeg"
},
{
"id": 99,
"image": "https://ai-image.weshop.com/db896663-7d43-45a7-a039-4972829136a1.jpeg_256x256.jpeg"
},
{
"id": 100,
"image": "https://ai-image.weshop.com/70af05fd-521f-4ea0-8d76-449623689b05.jpeg_256x256.jpeg"
},
{
"id": 101,
"image": "https://ai-image.weshop.com/e49c8891-04d6-47b6-9c6a-e382cd5f2114.jpeg_256x256.jpeg"
},
{
"id": 102,
"image": "https://ai-image.weshop.com/6db47550-d298-4638-978c-b50f285df9c2.jpeg_256x256.jpeg"
}
]
v1.0
[
{
"id": 1,
"image": "https://ai-image.weshop.com/2e0ed02c-a340-45e4-94f7-fb673f789bd2.png_256x256.jpeg"
},
{
"id": 2,
"image": "https://ai-image.weshop.com/c9fbbc00-882e-4e62-8ed0-24ae9d9f6dcf.png_256x256.jpeg"
},
{
"id": 3,
"image": "https://ai-image.weshop.com/ea5caebe-cf0a-4afa-8682-d160271ff82e.png_256x256.jpeg"
},
{
"id": 4,
"image": "https://ai-image.weshop.com/3c0aa4b9-3e2f-46ee-b007-d389f5fc7e0e.png_256x256.jpeg"
},
{
"id": 5,
"image": "https://ai-image.weshop.com/19bcc169-61bb-41e6-9271-1db56c286633.png_256x256.jpeg"
},
{
"id": 6,
"image": "https://ai-image.weshop.com/8020f99c-48fa-46fa-93b3-c131db1af65e.png_256x256.jpeg"
},
{
"id": 7,
"image": "https://ai-image.weshop.com/38eb48ac-d88c-444f-b7e4-1aa468e86ad4.jpeg_256x256.jpeg"
},
{
"id": 8,
"image": "https://ai-image.weshop.com/a2c95708-6d76-40e4-96b1-516c41952a49.jpeg_256x256.jpeg"
},
{
"id": 9,
"image": "https://ai-image.weshop.com/7d103f46-1870-45b7-b964-4d87f74904af.png_256x256.jpeg"
},
{
"id": 10,
"image": "https://ai-image.weshop.com/589721bf-57e6-42d4-b5a0-1762943c2529.png_256x256.jpeg"
},
{
"id": 11,
"image": "https://ai-image.weshop.com/4314366b-7fe5-411f-b1aa-242afe676d8b.png_256x256.jpeg"
},
{
"id": 12,
"image": "https://ai-image.weshop.com/05713c25-1d1a-4843-9480-5d8f8c982ecc.png_256x256.jpeg"
},
{
"id": 13,
"image": "https://ai-image.weshop.com/39bf919c-41a2-421c-9aff-3a5ecd1fa284.png_256x256.jpeg"
},
{
"id": 14,
"image": "https://ai-image.weshop.com/1988e7a1-9e09-49a8-aec8-d5578a2ca2c3.png_256x256.jpeg"
},
{
"id": 15,
"image": "https://ai-image.weshop.com/4ba7ccb2-5a4d-4ae4-afd7-076a2a5740c1.png_256x256.jpeg"
},
{
"id": 16,
"image": "https://ai-image.weshop.com/0056c61d-92fe-460c-b88d-934dc59999fc.png_256x256.jpeg"
},
{
"id": 17,
"image": "https://ai-image.weshop.com/db896663-7d43-45a7-a039-4972829136a1.jpeg_256x256.jpeg"
},
{
"id": 74,
"image": "https://ai-image.weshop.com/e49c8891-04d6-47b6-9c6a-e382cd5f2114.jpeg_256x256.jpeg"
},
{
"id": 75,
"image": "https://ai-image.weshop.com/70af05fd-521f-4ea0-8d76-449623689b05.jpeg_256x256.jpeg"
},
{
"id": 76,
"image": "https://ai-image.weshop.com/6db47550-d298-4638-978c-b50f285df9c2.jpeg_256x256.jpeg"
},
{
"id": 79,
"image": "https://ai-image.weshop.com/b2490472-735f-488b-b2ca-8a13cd3fcbaa.jpeg_256x256.jpeg"
},
{
"id": 80,
"image": "https://ai-image.weshop.com/2ed050e8-b005-4ddf-9f9c-02865b5a37a2.jpeg_256x256.jpeg"
},
{
"id": 81,
"image": "https://ai-image.weshop.com/8bca8bc2-23ec-4ac7-9a1c-f55d591621da.jpeg_256x256.jpeg"
}
]
Tags
- tag数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 生成标签Id | / |
name | 是 | string | 生成标签名称 | / |
v1.5
[
{
"id": 44,
"name": "大笑"
},
{
"id": 52,
"name": "微笑"
},
{
"id": 45,
"name": "时尚高冷"
},
{
"id": 43,
"name": "气质"
},
{
"id": 55,
"name": "优雅"
},
{
"id": 42,
"name": "单纯"
},
{
"id": 46,
"name": "婴儿"
},
{
"id": 57,
"name": "儿童"
},
{
"id": 56,
"name": "大童"
},
{
"id": 53,
"name": "少年"
},
{
"id": 47,
"name": "青年"
},
{
"id": 54,
"name": "中年"
},
{
"id": 48,
"name": "老年"
},
{
"id": 49,
"name": "背面"
},
{
"id": 58,
"name": "春天"
},
{
"id": 50,
"name": "夏天"
},
{
"id": 59,
"name": "秋天"
},
{
"id": 51,
"name": "冬天"
}
]
v1.0
[
{
"id": 1,
"name": "大笑"
},
{
"id": 2,
"name": "微笑"
},
{
"id": 3,
"name": "时尚高冷"
},
{
"id": 4,
"name": "气质"
},
{
"id": 5,
"name": "优雅"
},
{
"id": 6,
"name": "单纯"
},
{
"id": 7,
"name": "婴儿"
},
{
"id": 8,
"name": "儿童"
},
{
"id": 9,
"name": "大童"
},
{
"id": 10,
"name": "少年"
},
{
"id": 11,
"name": "青年"
},
{
"id": 12,
"name": "中年"
},
{
"id": 13,
"name": "老年"
},
{
"id": 37,
"name": "背面"
},
{
"id": 38,
"name": "春天"
},
{
"id": 39,
"name": "夏天"
},
{
"id": 40,
"name": "秋天"
},
{
"id": 41,
"name": "冬天"
}
]
商品图【旧版】
无需专业商业拍摄场地。智能体仅需简易的商品图片输入,即可生成精细的商业级摄影效果产品主图。
基础信息
AgentName
product
AgentVersion
- v1.5
- v1.0
注意事项
- 通常,更高版本的智能体具备更加出色的功能和性能。
- 如果您想以自然语言的方式描述需要生成的图像内容,请在执行任务时将参数类型(paramType)设置为“textDescription”。
- 若您倾向于使用商品图智能体的预设最佳实践模板,请在执行任务时将参数类型(paramType)设置为”template“。在此情况下,您必须提供locationId参数。您可以通过智能体的info API查询到合法的locationId的值。
- 如果您希望使用高级指令来执行任务,请将参数类型(paramType)设置为“prompt”。在这种模式下,您需要填写posPrompt、negPrompt以及denoiseType参数。
- 蒙板设置
- 如果您需要更换背景,在执行任务时请将maskType设置为“autoSubjectSegment”。智能体将使用自动主体分割技术生成蒙版图,此时无需提供customMask和customMaskUrl参数。
- 如果您需要自主选择保持不变的区域,请在操作之前准备好蒙版图,并在执行任务时将maskType设置为“custom”。在这种情况下,您须提供customMask或customMaskUrl参数。您可以使用weshop-segment sdk (opens in a new tab)编辑选区来生成蒙版图,或者使用其他工具生成所需的蒙版图。
任务
创建任务
请求参数
- initParams
参数样例:
{
"initParams": {
"taskName": "Create Task Api Test",
"originalImage": "https://ai-image.weshop.com/xxxxxxxx.png"
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 否 | string | 任务名称 | 不可超过20个字符 |
originalImage | 是 | string | 待处理的图片上传 | / |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskId | 是 | string | 任务ID 唯一标识 | / |
执行任务
请求参数
- params
参数样例:
// v1.5版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":372
}
}
// v1.0版本,快捷模板,自动主体分割
{
"params": {
"paramType": "template",
"maskType": "autoSubjectSegment",
"locationId":63
}
}
// v1.5与v1.0版本通用,文字描述,上传自定义mask
{
"params": {
"paramType": "textDescription",
"maskType": "custom",
"customMask": "<蒙版图base64编码>",
"textDescription": "变形金刚玩具出现在火星基地"
}
}
// v1.5与v1.0版本通用,快捷模板,自动主体分割
{
"params": {
"paramType": "prompt",
"maskType": "autoSubjectSegment",
"posPrompt": "Transformers toys appear at the Mars base.",
"negPrompt": "blue sky",
"denoiseType": 14
}
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
paramType | 是 | string | 参数类型 "textDescription":文字描述 "template":快捷模版 "prompt":高级自定义 | / |
maskType | 是 | string | 选择mask类型: "autoSubjectSegment":自动主体分割 "custom":手动上传mask信息 | 1. autoSubjectSegment自动主体分割为主体背景分割 2. 手动上传需要确保上传的Mask图与原图尺寸相同 |
customMask | 否 | string | 上传蒙版图的base64编码 | 1. 当Mask类型为"custom"时,必须上传该参数,否则无需上传 2. 图片除蒙版区域外为透明 3. 使用base64编码,不包含前缀"data:image/png;base64" |
customMaskUrl | 否 | string | 上传蒙版图的链接 | 使用外部图片链接时,须确保图片链接公网可访问,对图片的格式要求与customMask一致 |
locationId | 否 | int | 生成地点 | paramType为“template”时,必填。其他不填 |
textDescription | 否 | string | 文字描述的内容 | paramType为“textDescription”时,必填。其他不填 |
posPrompt | 否 | string | 正向提示词 | paramType为“prompt”时,必填。其他不填 |
negPrompt | 否 | string | 反向提示词 | paramType为“prompt”时,必填。其他不填 |
denoiseType | 否 | int | 可选项: 14:自由发挥 15:参考原图 | paramType为“prompt”时,必填。其他不填 |
resultImageFormat | 否 | string | 选择生成结果图片的格式,可选项: "jpg" "png" | 默认为png |
resizeToOriginalImage | 否 | bool | 是否将生成结果图片缩放至原图的尺寸 | 默认为false |
batchCount | 否 | int | 设置本次执行生成图片的数量,最小为1,最大为4 | 默认为4,超出范围取默认值 |
响应参数
- data
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID 唯一标识 | / |
查询任务
请求参数
- json格式,参数样例
{
"executionId":"<execution id>"
}
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 否 | string | 任务执行ID | / |
taskId | 否 | string | 任务ID | 如果传入taskId参数,最多返回近20条执行信息 |
响应参数
- initParams
当前任务的初始信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
taskName | 是 | string | 任务名称 | / |
originalImage | 是 | string | 任务原图 | / |
- execution
执行信息
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
executionId | 是 | string | 任务执行ID | / |
status | 是 | string | 任务执行状态: Segmenting:自动选择主体中 Pending:排队中 Running :进行中 Success:已完成 | / |
params | 是 | object | 执行任务相关参数 | / |
executionTime | 是 | string | 任务执行时间点 | / |
results | 是 | array[object] | 任务执行结果信息 | / |
- result
执行结果
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
status | 是 | string | 执行结果枚举值 Running :执行中 Success:执行成功 Failed:执行失败 Pending:等待中 | / |
image | 是 | string | 生成的最终图片 | / |
progress | 否 | string | 处理进度,如:0.71,表示已处理71% | / |
error | 否 | string | 处理失败的信息 | 当status为Failed时,一定会返回 |
信息查询
查询智能体相关信息 传入智能体名称(agentName)和版本号(agentVersion),获得相应的配置参数信息。
请求参数
参数名 | 必填 | 参数类型 | 描述 | 注意 |
---|---|---|---|---|
agentName | 是 | string | 智能体名称: "product" | / |
agentVersion | 是 | string | 智能体版本: "v1.0" "v1.5" | / |
响应参数
- data
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
locations | 是 | array[object] | 生成地点相关参数信息 | 1. 请求智能体信息查询接口或者查看Location展示获取该智能体的地点信息 2. 数据结构请查看Locations |
agentVersion | 是 | string | 智能体版本 | / |
Locations
- locations数据结构
参数名称 | 必填 | 类型 | 描述 | 注意 |
---|---|---|---|---|
id | 是 | int | 地点Id | / |
image | 是 | string | 地点展示图片 | / |
name | 是 | string | 地点名称 | / |
v1.5
[
{
"id": 265,
"image": "https://ai-image.weshop.com/8dfc9e33-c8cc-4714-aaa0-ebe0bed9cc6d.png_256x256.jpeg",
"name": "纯色摄影棚"
},
{
"id": 266,
"image": "https://ai-image.weshop.com/2bc446c7-3283-41cb-b5e2-6b2fbae36680.png_256x256.jpeg",
"name": "客厅"
},
{
"id": 267,
"image": "https://ai-image.weshop.com/7fb89f2e-6563-4079-b068-4233e14e52f3.png_256x256.jpeg",
"name": "卧室"
},
{
"id": 268,
"image": "https://ai-image.weshop.com/1c689468-c2b7-4e92-86ad-2c036edf0769.png_256x256.jpeg",
"name": "咖啡店"
},
{
"id": 269,
"image": "https://ai-image.weshop.com/e0341bc6-3849-4bf2-b4be-18ca5a314f10.png_256x256.jpeg",
"name": "健身房"
},
{
"id": 270,
"image": "https://ai-image.weshop.com/d9ea3fa1-026e-4ec3-9d6e-57cc4db8596b.png_256x256.jpeg",
"name": "厨房"
},
{
"id": 271,
"image": "https://ai-image.weshop.com/c3a9c783-529c-45a6-a454-8bfedc2b6b64.png_256x256.jpeg",
"name": "办公室"
},
{
"id": 273,
"image": "https://ai-image.weshop.com/e31f920c-5bbb-4b3d-9ff4-83b443f67628.png_256x256.jpeg",
"name": "岩石鲜花"
},
{
"id": 274,
"image": "https://ai-image.weshop.com/2ae13f92-b0da-4a74-971f-7870e3ce469f.png_256x256.jpeg",
"name": "湖水植物"
},
{
"id": 275,
"image": "https://ai-image.weshop.com/39c93692-d711-4a42-8f64-f91dc26ef6f6.png_256x256.jpeg",
"name": "海边沙滩椰子树"
},
{
"id": 276,
"image": "https://ai-image.weshop.com/39422383-1c3e-497a-8b3d-4e16c1b3041a.png_256x256.jpeg",
"name": "渐变背景"
},
{
"id": 277,
"image": "https://ai-image.weshop.com/f43f365f-2589-47cf-a480-6ff27f9239cc.png_256x256.jpeg",
"name": "雪景"
},
{
"id": 278,
"image": "https://ai-image.weshop.com/5c53e8ec-942b-414e-b6ba-11c82ba567a8.png_256x256.jpeg",
"name": "峡谷树河"
},
{
"id": 279,
"image": "https://ai-image.weshop.com/10fc607e-e6d2-4f38-884a-625a478d31f0.png_256x256.jpeg",
"name": "潮湿环境"
},
{
"id": 280,
"image": "https://ai-image.weshop.com/8d6b997d-e50c-4225-90ad-09192bd697e9.png_256x256.jpeg",
"name": "小黄花"
},
{
"id": 281,
"image": "https://ai-image.weshop.com/65da01a3-2a61-492e-88cb-28ad5999bcd8.png_256x256.jpeg",
"name": "大理石烟雾"
},
{
"id": 282,
"image": "https://ai-image.weshop.com/80c5fd30-8971-48ee-b031-da1e372b0ad6.png_256x256.jpeg",
"name": "树花日升"
},
{
"id": 283,
"image": "https://ai-image.weshop.com/176261a6-5703-4e4a-aa2f-b80046d9d3d4.png_256x256.jpeg",
"name": "加油站"
},
{
"id": 284,
"image": "https://ai-image.weshop.com/bd5b4be4-6713-44b8-b79c-f448370589a1.png_256x256.jpeg",
"name": "热带植物"
},
{
"id": 285,
"image": "https://ai-image.weshop.com/6ab0dbaa-eca8-4de4-9c37-539c1e7e42ac.png_256x256.jpeg",
"name": "西部公路"
},
{
"id": 286,
"image": "https://ai-image.weshop.com/ee4f43cf-1267-473b-b0e1-99787639f17e.png_256x256.jpeg",
"name": "废弃工厂"
},
{
"id": 287,
"image": "https://ai-image.weshop.com/b9b12eef-8da4-40f8-a6fc-fa24f043cd3a.png_256x256.jpeg",
"name": "樱花"
},
{
"id": 288,
"image": "https://ai-image.weshop.com/3acc13d3-5d63-4e44-808b-9925ba28154a.png_256x256.jpeg",
"name": "太空站"
},
{
"id": 304,
"image": "https://ai-image.weshop.com/c6e02479-9ae9-427b-ad8a-7ab59ffc631b.png_256x256.jpeg",
"name": "家居桌面"
},
{
"id": 305,
"image": "https://ai-image.weshop.com/82424c8b-c3f8-437e-b168-916856bf3b90.png_256x256.jpeg",
"name": "户外露营"
},
{
"id": 306,
"image": "https://ai-image.weshop.com/bb7a7940-cedb-40bf-bf68-7cc3e82e808d.png_256x256.jpeg",
"name": "操场跑道"
},
{
"id": 312,
"image": "https://ai-image.weshop.com/dde2daab-7a74-4dbd-8eb9-c7b95b9ed469.png_256x256.jpeg",
"name": "大理石绿植"
},
{
"id": 313,
"image": "https://ai-image.weshop.com/5a12840f-e865-4180-9c99-063df000a04d.png_256x256.jpeg",
"name": "水面波纹"
},
{
"id": 314,
"image": "https://ai-image.weshop.com/3a330fb7-3135-4a2f-b14f-b6de6efa8620.png_256x256.jpeg",
"name": "温馨角落"
},
{
"id": 315,
"image": "https://ai-image.weshop.com/c8db2f3b-1e3a-4724-82e5-84a2793b2b64.png_256x256.jpeg",
"name": "毛茸茸"
},
{
"id": 316,
"image": "https://ai-image.weshop.com/cadb5348-58d4-4139-8b37-214fe12d8ca1.png_256x256.jpeg",
"name": "丝绸"
}
]