/** * SubmitDrawPortraitJob返回参数结构体 */ export interface SubmitDrawPortraitJobResponse { /** *
提交生成写真图片任务 ID。
*/ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RefineImage请求参数结构体 */ export interface RefineImageRequest { /** * 输入图 Url。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 */ InputUrl?: string; /** * 输入图 Base64 数据。 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。 图片限制:转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。 */ InputImage?: string; /** * 返回图像方式(base64 或 url),二选一,默认为 base64。url 有效期为1小时。 示例值:url */ RspImgType?: string; } /** * logo参数 */ export interface LogoParam { /** * 水印 Url 注意:此字段可能返回 null,表示取不到有效值。 */ LogoUrl?: string; /** * 水印 Base64,Url 和 Base64 二选一传入,如果都提供以 Url 为准 注意:此字段可能返回 null,表示取不到有效值。 */ LogoImage?: string; /** * 水印图片位于生成结果图中的坐标,将按照坐标对标识图片进行位置和大小的拉伸匹配 注意:此字段可能返回 null,表示取不到有效值。 */ LogoRect?: LogoRect; } /** * SubmitMemeJob返回参数结构体 */ export interface SubmitMemeJobResponse { /** *任务id
*/ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryMemeJob请求参数结构体 */ export interface QueryMemeJobRequest { /** * 查询表情动图生成任务 ID。 */ JobId: string; } /** * QueryTextToImageProJob返回参数结构体 */ export interface QueryTextToImageProJobResponse { /** * 当前任务状态码: 1:等待中、2:运行中、4:处理失败、5:处理完成。 */ JobStatusCode?: string; /** * 当前任务状态:排队中、处理中、处理失败或者处理完成。 */ JobStatusMsg?: string; /** * 任务处理失败错误码。 */ JobErrorCode?: string; /** * 任务处理失败错误信息。 */ JobErrorMsg?: string; /** * 生成图 URL 列表,有效期1小时,请及时保存。 */ ResultImage?: Array写真模型 ID。由英文大小写字母、数字及下划线组成。
用于唯一标识一个写真模型,一个写真模型只能用于一个人物的写真图片生成。
写真模型训练用的基础图像 URL,用于固定写真模型可生成的人物。
图片数量:1张。
图片内容:单人,脸部清晰。
图片限制:单边分辨率小于2000px,转成 Base64 字符串后小于 5MB。
写真模型训练用的图像 URL 列表,仅常规训练模式需要上传。
图片数量:19 - 24 张。
图片内容:单人,脸部清晰,和基础图像中的人物为同一人。
图片限制:单边分辨率小于2000px,转成 Base64 字符串后小于 5MB。
训练图像质量过滤开关配置。
支持开启或关闭对训练图像分辨率下限、脸部区域大小、脸部遮挡的过滤,默认开启以上过滤。
如果训练图像内包含多人脸或无人脸、和 Base 人像不为同一人也将被过滤,不可关闭该过滤条件。
建议:关闭以上过滤可能导致写真生成效果受损,建议使用单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的图像进行训练。
示例值:{"Resolution":1,"Size":1,"Occlusion":1}
训练模式。
默认使用常规训练模式。如果使用快速训练模式和免训练模式,只需要在 BaseUrl 中传入1张图片,Urls.N 中无需传入图片。
0:常规训练模式,上传多张图片用于模型训练,完成训练后可生成写真图片。
1:快速训练模式,仅需上传1张图片用于模型训练,训练速度更快,完成训练后可生成写真图片。
2:免训练模式,仅需上传1张图片,跳过模型训练环节,直接生成写真图片。
扩展后的比例(宽:高),需要不等于原图比例。
支持:1:1、4:3、3:4、16:9、9:16
输入图 Base64 数据。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
输入图 Url。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
返回图像方式(base64 或 url),二选一,默认为 base64。url 有效期为1小时。
*/ RspImgType?: string; /** *为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
根据入参 RspImgType 填入不同,返回不同的内容。
如果传入 base64 则返回生成图 Base64 编码。
如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
如果 MaskUrl 未传,则返回使用内置商品分割算法得到的 Mask 结果。
*/ MaskImage?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryMemeJob返回参数结构体 */ export interface QueryMemeJobResponse { /** * 当前任务状态码: 1:等待中、2:运行中、4:处理失败、5:处理完成。 */ JobStatusCode?: string; /** * 当前任务状态:排队中、处理中、处理失败或者处理完成。 */ JobStatusMsg?: string; /** * 任务处理失败错误码。 */ JobErrorCode?: string; /** * 任务处理失败错误信息。 */ JobErrorMsg?: string; /** * 生成图 URL,有效期1小时,请及时保存。 */ ResultImage?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * QueryDrawPortraitJob返回参数结构体 */ export interface QueryDrawPortraitJobResponse { /** * 任务状态码。 INIT: 初始化、WAIT:等待中、RUN:运行中、FAIL:处理失败、DONE:处理完成。 */ JobStatusCode?: string; /** * 任务状态信息。 */ JobStatusMsg?: string; /** * 任务错误码。 */ JobErrorCode?: string; /** * 任务错误信息。 */ JobErrorMsg?: string; /** * 结果 URL 数组。 URL 有效期1小时,请及时保存。 */ ResultUrls?: Array任务ID。
*/ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitTextToImageProJob返回参数结构体 */ export interface SubmitTextToImageProJobResponse { /** * 任务 ID。 */ JobId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SubmitTrainPortraitModelJob请求参数结构体 */ export interface SubmitTrainPortraitModelJobRequest { /** * 在上传写真训练图片时指定的写真模型 ID。 每个 AI 写真模型自训练完成起1年内有效,有效期内可使用模型生成图片,期满后需要重新训练模型。 */ ModelId: string; } /** * SketchToImage请求参数结构体 */ export interface SketchToImageRequest { /** *用于线稿生图的文本描述。
最多支持200个 utf-8 字符。
建议格式:线稿中的主体对象+画面场景+配色/材质/元素/风格等
线稿图 Base64 数据。
Base64 和 Url 必须提供一个,如果都提供以Url 为准。
图片限制:黑白线稿图片,单边分辨率小于5000px且大于128px(分辨率过小会导致效果受损),转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
线稿图 Url。
Base64 和 Url 必须提供一个,如果都提供以Url 为准。
图片限制:黑白线稿图片,单边分辨率小于5000px且大于128px(分辨率过小会导致效果受损),转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
示例值:{"LogoUrl": "https://cos.ap-guangzhou.myqcloud.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}
返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。生成图分辨率较大时建议选择 url,使用 base64 可能因图片过大导致返回失败。
*/ RspImgType?: string; } /** * 人脸框坐标 */ export interface Rect { /** *人脸框左上角横坐标。
*/ X?: number; /** *人脸框左上角纵坐标。
*/ Y?: number; /** *人脸框宽度。
单位:px
人脸框高度。
单位:px
美照模板图 URL。
图片限制:模板图中最多出现5张人脸,单边分辨率大于300px,转成 Base64 字符串后小于 10MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
用户图 URL 列表,以及模板图中需要替换成用户的人脸框信息。
一张美照中可包含1 ~ 5个用户形象。每个用户需上传1 ~ 6张照片,仅支持单人照。
模板图中的人脸数量需要大于等于用户个数。如果不传每个用户在模板图中的人脸框位置,默认按照模板图人脸框从大到小的顺序进行替换。如需自定义顺序,需要依次上传每个用户在模板图中的人脸框位置。
图片限制:每张图片转成 Base64 字符串后小于 10MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。建议使用单人、正脸、脸部区域占比较大、脸部清晰无遮挡、无大角度偏转、无夸张表情的用户图。
示例值:[{"ImageUrls": ["https://cos.ap-guangzhou.myqcloud.com/image.jpg"]}]
美照生成数量。
支持1 ~ 4张,默认生成4张。
美照生成风格。
仅对单人美照生效,单人可支持选择不同风格。需按照美照生成数量,在数组中逐一填入每张美照的风格名称。如果不传,默认取不重复的随机风格顺序。
多人美照只支持 balanced 一种风格,该参数不生效。
可选风格:
相似度系数,越高越像用户图。
取值范围[0, 1],默认为0.6。
超分选项,默认不做超分,可选开启。
x2:2倍超分
x4:4倍超分
为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
示例值:{"LogoUrl": "https://cos.ap-guangzhou.myqcloud.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}
图像类型,默认为人像。
human:人像头像,仅支持人像图片输入,建议避免上传无人、多人、人像过小的图片。
pet:萌宠贴纸,仅支持动物图片输入,建议避免上传无动物、多动物、动物过小的图片。
头像风格,仅在人像模式下生效。
若使用人像模式,请在 百变头像风格列表 中选择期望的风格,传入风格编号,不传默认使用 flower 风格。
若使用萌宠贴纸模式,无需选择风格,该参数不生效。
输入图 Base64 数据。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
输入图 Url。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
输入人像图的质量检测开关,默认开启,仅在人像模式下生效。
1:开启
0:关闭
建议开启检测,可提升生成效果,关闭检测可能因输入图像质量较差导致生成效果受损。
开启后,将增强对输入图像的质量要求,如果输入图像单边分辨率<500、图像中人脸占比较小、存在多人、没有检测到人脸、人脸不完整、人脸遮挡等,将被拦截。
关闭后,将降低对输入图像的质量要求,如果图像中没有检测到人脸或人脸占比过小等,将被拦截。
为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。
*/ RspImgType?: string; } /** * 输入框 */ export interface LogoRect { /** *左上角X坐标
注意:此字段可能返回 null,表示取不到有效值。 */ X?: number; /** *左上角Y坐标
注意:此字段可能返回 null,表示取不到有效值。 */ Y?: number; /** *方框宽度
单位为 px
方框高度
单位为 px
根据入参 RspImgType 填入不同,返回不同的内容。 如果传入 base64 则返回生成图 Base64 编码。 如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
*/ ResultImage?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReplaceBackground请求参数结构体 */ export interface ReplaceBackgroundRequest { /** *商品原图 Url。
图片限制:单边分辨率小于4000px,长宽比在2:5 ~ 5:2之间,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
对新背景的文本描述。
最多支持256个 utf-8 字符,支持中、英文。
如果 Prompt = "BackgroundTemplate" 代表启用背景模板,需要在参数 BackgroundTemplate 中指定一个背景名称。
反向提示词。
最多支持256个 utf-8 字符,支持中、英文。
商品图中的商品主体名称。
最多支持50个 utf-8 字符,支持中、英文。
建议说明商品主体,否则影响生成效果。
背景模板。
仅当 Prompt = "BackgroundTemplate" 时生效,可支持的模板详见 商品背景模板列表 ,请传入字段“背景名称”中的值。
商品 Mask 图 Url,要求背景透明,保留商品主体。
如果不传,将自动使用内置的商品分割算法得到 Mask。
支持自定义上传 Mask,如果该参数不为空,则以实际上传的数据为准。
图片限制:Mask 图必须和商品原图分辨率一致,转成 Base64 字符串后小于 6MB,格式仅支持 png。
替换背景后生成的商品图分辨率。
支持生成单边分辨率大于500px且小于4000px、长宽比在2:5 ~ 5:2之间的图片,不传默认生成1280:1280。
建议图片比例为1:1、9:16、16:9,生成效果更佳,使用其他比例的生成效果可能不如建议比例。
为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
示例值:{"LogoUrl": "https://cos.ap-guangzhou.myqcloud.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}
返回图像方式(base64 或 url) ,二选一,默认为 base64。url 有效期为1小时。
生成图分辨率较大时建议选择 url,使用 base64 可能因图片过大导致返回失败。
表情模板。
请在 表情动图模板列表 中选择期望的模板,传入 Pose 名称。
人像参考图 Base64 数据。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
人像参考图 Url。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
生成分辨率,单位为 px。
真人类型支持256、512,默认为256,
卡通类型仅支持512。
自定义文案。
仅对真人类型的 Pose 生效,将在生成的表情动图中显示指定的文字。如果传入的字符串长度大于10,只截取前10个显示。
如果不传,默认使用自带的文案。
如果 text = "" 空字符串,代表不在表情动图中添加文案。
头发遮罩开关。
true:裁剪过长的头发。
false:不裁剪过长的头发。
仅对卡通类型的 Pose 生效,默认为 false。
为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
示例值:{"LogoUrl": "https://cos.ap-guangzhou.myqcloud.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}
根据入参 RspImgType 填入不同,返回不同的内容。
如果传入 base64 则返回生成图 Base64 编码。
如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
输入图 Base64 数据。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
输入图 Url。
Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:单边分辨率小于5000px,转成 Base64 字符串后小于 6MB,格式支持 jpg、jpeg、png、bmp、tiff、webp。
消除区域 Mask 图 Base64 数据。
Mask 为单通道灰度图,待消除部分呈白色区域,原图保持部分呈黑色区域。
Mask 的 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:Mask 分辨率需要和输入原图保持一致,转成 Base64 字符串后小于 6MB。
消除区域 Mask 图 Url。
Mask 为单通道灰度图,待消除部分呈白色区域,原图保持部分呈黑色区域。
Mask 的 Base64 和 Url 必须提供一个,如果都提供以 Url 为准。
图片限制:Mask 分辨率需要和输入原图保持一致,转成 Base64 字符串后小于 6MB。
返回图像方式(base64 或 url),二选一,默认为 base64。url 有效期为1小时。
*/ RspImgType?: string; /** *为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
根据入参 RspImgType 填入不同,返回不同的内容。
如果传入 base64 则返回生成图 Base64 编码。
如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
用于提示对应上传的Urls训练图片是否符合要求,如果未通过需要重新上传。如果基础图像不符合要求会直接通过ErrorCode提示。如果您选择了快速模式,该参数返回为空数组。
*/ ResultDetails?: Array根据入参 RspImgType 填入不同,返回不同的内容。
如果传入 base64 则返回生成图 Base64 编码。
如果传入 url 则返回的生成图 URL , 有效期1小时,请及时保存。
写真模型 ID。
*/ ModelId: string; /** *写真风格模板。
请在 AI 写真风格列表 中选择期望的风格,传入风格编号。
本次生成的图片数量,取值范围[1,4]
*/ ImageNum: number; /** *为生成结果图添加标识的开关,默认为1。
1:添加标识。
0:不添加标识。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图是 AI 生成的图片。
标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
示例值:{"LogoUrl": "https://cos.ap-guangzhou.myqcloud.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}
清晰度,单位为 px。
支持以下选项:
sd:基础版,分辨率512:640
hd:高清畅享版,分辨率1024:1280
hdpro:高清优享版,分辨率1024:1280(推荐)
uhd:超清版,分辨率2048:2560
不填默认为sd。